source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/scanfile.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

File size: 3.5 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>scanfile.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="read_vermair.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="selectfile.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/WIDGET/AUTOUR_de_XXX/</font></h1>
58    <h2>scanfile.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66   
67
68     
69      <a name="#_scanfile"></a>
70
71      <h2>scanfile  <font size="-1" color="#006633">
72</font></h2>
73
74      <p><font face="Courier"><i>result = </i>scanfile(<i><a href="#_scanfile_keyword_namefile">namefile</a></i>, <a href="#_scanfile_keyword_GRID">GRID</a>=<i>scalar string</i>, <a href="#_scanfile_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
75
76   
77
78
79    <h3>Return value</h3>
80
81
82   
83    <h3>Parameters</h3>
84   
85
86    <a name="#_scanfile_keyword_namefile"></a>
87    <h4>namefile&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
88     
89     
90     
91     
92     
93     
94     
95     
96    </h4>
97
98   
99
100   
101   
102
103   
104    <h3>Keywords</h3>
105
106   
107    <a name="#_scanfile_keyword_GRID"></a>
108    <h4>GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109     
110     
111     
112     
113     
114      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
115      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'T'</i></font>
116     
117    </h4>
118
119   
120 Used to specify on which grid type are located the data
121
122   
123    <a name="#_scanfile_keyword__EXTRA"></a>
124    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125     
126     
127     
128     
129     
130     
131     
132     
133    </h4>
134
135   
136 Used to pass keywords to <a href="../../..//Utilities/isafile.html">isafile</a>,
137 <a href="../../..//ReadWrite/ncdf_getaxis.html">ncdf_getaxis</a> and <a href="../../..//ReadWrite/ncdf_gettime.html">ncdf_gettime</a>
138
139   
140   
141
142    <h3>Examples</h3><pre>
143
144    </pre><h3>Version history</h3>
145   
146    <h4>Version</h4>
147 $Id: scanfile.pro 327 2007-12-13 16:22:35Z pinsard $
148
149    <h4>History</h4>
150
151   
152
153    <h3>Known issues</h3>
154   
155   
156    <h4>Todo items</h4>
157 seb : I don't know what to do with that...
158
159    <h4>Restrictions</h4>
160
161
162    <h3>Other attributes</h3>
163   
164   
165    <h4>Uses routines</h4>
166
167   
168   
169   
170
171    <font size="-3"><p>&nbsp;</p></font>
172    <hr size="1" color="#CCCCCC"/>
173     
174
175   
176
177    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
178
179  </body>
180</html>
Note: See TracBrowser for help on using the repository browser.