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

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

update documentation

File size: 3.6 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
66 It is the same thing that <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a> but here, we use it
67 to display the content of a procedure or of a function located in the !path
68 ".pro" suffix will be appended if needed.
69
70
71   
72
73     
74      <a name="#_xfile"></a>
75
76      <h2>xfile  <font size="-1" color="#006633">
77 Utilities Widget
78</font></h2>
79
80      <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>
81
82   
83
84
85   
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_xfile_keyword_filename"></a>
92    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93      <font size="-1" color="#006633">in</font>
94     
95     
96      <font size="-1" color="#006633">required</font>
97     
98      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
99     
100     
101    </h4>
102
103   
104 It is the name of the procedure or of the function
105 we want to display (with or without .pro at the end).
106 FILENAME should be located in !path.
107 ".pro" suffix will be appended if needed.
108
109   
110   
111
112   
113    <h3>Keywords</h3>
114
115   
116    <a name="#_xfile_keyword__EXTRA"></a>
117    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
118     
119     
120     
121     
122     
123     
124     
125     
126    </h4>
127
128   
129 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a>
130
131   
132   
133
134    <h3>Examples</h3><pre>
135
136   IDL> xfile,'plt'
137
138    </pre><h3>Version history</h3>
139   
140    <h4>Version</h4>
141 $Id: xfile.pro 375 2008-08-08 15:55:40Z pinsard $
142
143    <h4>History</h4>
144 Sebastien Masson (smasson@lodyc.jussieu.fr)
145 7/1/99
146 6/7/1999: compatibility mac and windows
147
148   
149
150    <h3>Known issues</h3>
151   
152   
153   
154    <h4>Restrictions</h4>
155 Triggers the <a href="/Applications/itt/idl64/help/online_help/XMANAGER.html">XMANAGER</a> if it is not already in use.
156
157
158   
159   
160   
161   
162   
163   
164   
165
166    <font size="-3"><p>&nbsp;</p></font>
167    <hr size="1" color="#CCCCCC"/>
168     
169
170   
171
172    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
173
174  </body>
175</html>
Note: See TracBrowser for help on using the repository browser.