source: trunk/SRC/Documentation/idldoc_html_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: 4.9 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>scanfile.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="scanfile.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="../../../../../ToBeReviewed/WIDGET/AUTOUR_de_XXX//scanfile.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="read_vermair.html">&lt;&lt;prev file</a> | <a href="selectfile.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="scanfile.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">ToBeReviewed/WIDGET/AUTOUR_de_XXX/</a></h1>
82      <h2 class="pro_file">scanfile.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90</div>
91
92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_scanfile">
104
105          <h2><a class="top" href="#container">top</a>scanfile <span class="categories">
106</span></h2>
107       
108          <p class="header">
109            <span class="result">result = </span>scanfile(<span class="result"><a href="#_scanfile_param_namefile">namefile</a></span>, <a href="#_scanfile_keyword_GRID">GRID</a>=<span class="result">scalar string</span>, <a href="#_scanfile_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
110       
111          <div class="comments">
112</div>
113
114          <h3>Return value</h3><div class="preformat">
115</div>
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_scanfile_param_namefile">namefile&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122             
123             
124             
125             
126             
127             
128             
129             
130            </h4>
131       
132          <div class="comments">
133</div>
134           
135
136         
137
138         
139
140            <h3>Keywords</h3>
141           
142            <h4 id="_scanfile_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143             
144             
145             
146             
147             
148              <span class="attr">type:</span> <span class="value">scalar string</span>
149              <span class="attr">default:</span> <span class="value">'T'</span>
150             
151            </h4>
152       
153            <div class="comments">
154 Used to specify on which grid type are located the data
155</div>
156           
157            <h4 id="_scanfile_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158             
159             
160             
161             
162             
163             
164             
165             
166            </h4>
167       
168            <div class="comments">
169 Used to pass keywords to <a href="../../..//Utilities/isafile.html">isafile</a>,
170 <a href="../../..//ReadWrite/ncdf_getaxis.html">ncdf_getaxis</a> and <a href="../../..//ReadWrite/ncdf_gettime.html">ncdf_gettime</a>
171</div>
172           
173         
174
175          <h3>Examples</h3><div class="preformat">
176</div>
177          <h3>Version history</h3>
178         
179          <h4>Version</h4><div class="preformat">
180 $Id: scanfile.pro 327 2007-12-13 16:22:35Z pinsard $
181</div>
182          <h4>History</h4><div class="preformat">
183</div>
184         
185         
186          <h3>Known issues</h3>
187         
188         
189          <h4>Todo items</h4><div class="preformat">
190 seb : I don't know what to do with that...
191</div>
192          <h4>Restrictions</h4><div class="preformat">
193</div>
194       
195          <h3>Other attributes</h3>
196         
197         
198          <h4>Uses routines</h4><div class="preformat">
199</div>
200         
201         
202         
203       
204          <h3>Statistics</h3>
205          <table class="statistics">
206            <tr><td>McCabe cyclic</td><td>          24</td></tr>
207            <tr><td>McCabe essential</td><td>           1</td></tr>
208            <tr><td>McCabe modular design</td><td>           1</td></tr>
209          </table>
210         
211       
212        </div>
213       
214      </div>
215
216     
217
218      <div id="tagline">Produced by IDLdoc 2.0.</div>
219
220    </div>
221
222  </body>
223</html>
Note: See TracBrowser for help on using the repository browser.