source: trunk/SRC/Documentation/idldoc_html_output/Utilities/xfile.html

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation
File size: 4.8 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>xfile.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="xfile.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Utilities//xfile.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="undefine.html">&lt;&lt;prev file</a> | <a href="xhelp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="xfile.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Utilities/</a></h1>
82      <h2 class="pro_file">xfile.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 display an ASCII file in a widget.
91
92 It is the same thing that <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a> but here, we use it
93 to display the content of a procedure or of a function located in the !path
94 ".pro" suffix will be appended if needed.
95</div>
96
97     
98
99     
100
101     
102
103     
104
105      <div id="routine_details">
106       
107
108        <div class="routine_details" id="_xfile">
109
110          <h2><a class="top" href="#container">top</a>xfile <span class="categories">
111 Utilities Widget
112</span></h2>
113       
114          <p class="header">
115            xfile<span class="result">, <a href="#_xfile_param_filename">filename</a></span>, <a href="#_xfile_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
116       
117          <div class="comments">
118</div>
119
120         
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_xfile_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127              <span class="attr">in</span>
128             
129             
130              <span class="attr">required</span>
131             
132              <span class="attr">type:</span> <span class="value">scalar string</span>
133             
134             
135            </h4>
136       
137          <div class="comments">
138 It is the name of the procedure or of the function
139 we want to display (with or without .pro at the end).
140 FILENAME should be located in !path.
141 ".pro" suffix will be appended if needed.
142</div>
143           
144
145         
146
147         
148
149            <h3>Keywords</h3>
150           
151            <h4 id="_xfile_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152             
153             
154             
155             
156             
157             
158             
159             
160            </h4>
161       
162            <div class="comments">
163 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a>
164</div>
165           
166         
167
168          <h3>Examples</h3><div class="preformat">
169
170   IDL> xfile,'plt'
171</div>
172          <h3>Version history</h3>
173         
174          <h4>Version</h4><div class="preformat">
175 $Id: xfile.pro 375 2008-08-08 15:55:40Z pinsard $
176</div>
177          <h4>History</h4><div class="preformat">
178 Sebastien Masson (smasson@lodyc.jussieu.fr)
179 7/1/99
180 6/7/1999: compatibility mac and windows
181</div>
182         
183         
184          <h3>Known issues</h3>
185         
186         
187         
188          <h4>Restrictions</h4><div class="preformat">
189 Triggers the <a href="/Applications/itt/idl64/help/online_help/XMANAGER.html">XMANAGER</a> if it is not already in use.
190</div>
191       
192         
193         
194         
195         
196         
197         
198         
199       
200          <h3>Statistics</h3>
201          <table class="statistics">
202            <tr><td>McCabe cyclic</td><td>           5</td></tr>
203            <tr><td>McCabe essential</td><td>           1</td></tr>
204            <tr><td>McCabe modular design</td><td>           1</td></tr>
205          </table>
206         
207       
208        </div>
209       
210      </div>
211
212     
213
214      <div id="tagline">Produced by IDLdoc 2.0.</div>
215
216    </div>
217
218  </body>
219</html>
Note: See TracBrowser for help on using the repository browser.