source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/xfile.html @ 249

Last change on this file since 249 was 249, checked in by smasson, 17 years ago

update documentation

File size: 3.2 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>xfile.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="undefine.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="xhelp.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>xfile.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 display an ASCII file in a widget.
65 It is the same thing that <proidl>xdisplayfile<proidl> but here, we use it
66 to display the content of a procedure or of a function located in the !path
67 ".pro" suffix will be appended if needed.
68
69
70   
71
72     
73      <a name="#_xfile"></a>
74
75      <h2>xfile  <font size="-1" color="#006633">
76 Utilities
77</font></h2>
78
79      <p><font face="Courier">xfile<i>, <a href="#_xfile_keyword_filename">filename</a></i>, <a href="#_xfile_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
80
81   
82
83
84   
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_xfile_keyword_filename"></a>
91    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97     
98     
99     
100    </h4>
101
102   
103 It is the name of the procedure or of the function
104 we want to display (with or without .pro at the end).
105
106   
107   
108
109   
110    <h3>Keywords</h3>
111
112   
113    <a name="#_xfile_keyword__EXTRA"></a>
114    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
115     
116     
117     
118     
119     
120     
121     
122     
123    </h4>
124
125   
126 Used to pass keywords to <proidl>xdisplayfile</proidl>
127
128   
129   
130
131    <h3>Examples</h3><pre>
132 IDL> xfile,'plt'
133
134    </pre><h3>Version history</h3>
135   
136    <h4>Version</h4>
137 $Id: xfile.pro 242 2007-04-06 08:35:17Z pinsard $
138
139    <h4>History</h4>
140 Sebastien Masson (smasson@lodyc.jussieu.fr)
141 7/1/99
142 6/7/1999: compatibility mac and windows
143
144   
145
146   
147   
148   
149   
150   
151
152   
153   
154   
155   
156   
157   
158   
159
160    <font size="-3"><p>&nbsp;</p></font>
161    <hr size="1" color="#CCCCCC"/>
162     
163
164   
165
166    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
167
168  </body>
169</html>
Note: See TracBrowser for help on using the repository browser.