source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/getfile.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html

File size: 4.7 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>getfile.pro (IDLdoc API 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="getfile.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="delchr.html">&lt;&lt;prev file</a> | <a href="getwrd.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="getfile.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">ToBeReviewed/STRING/</a></h1>
82      <h2 class="pro_file">getfile.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_getfile">
103
104          <h2><a class="top" href="#container">top</a>getfile </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>getfile(<span class="result"><a href="#_getfile_param_filein">filein</a></span>, <a href="#_getfile_keyword_error">error</a>=<span class="result">error</span>, <a href="#_getfile_keyword_help">help</a>=<span class="result">help</span>, <a href="#_getfile_keyword_quiet">quiet</a>=<span class="result">quiet</span>, <a href="#_getfile_keyword_find">find</a>=<span class="result">find</span>)</p>
108       
109          <div class="comments">
110 NAME:
111       GETFILE
112 PURPOSE:
113       Read a text file into a string array.
114 CATEGORY:
115 CALLING SEQUENCE:
116       s = getfile(f)
117 INPUTS:
118       f = text file name.      in
119 KEYWORD PARAMETERS:
120       Keywords:
121         ERROR=err  error flag: 0=ok, 1=file not opened,
122           2=no lines in file.
123         /QUIET means give no error message.
124
125         /FIND search te file in the all !path directories (use
126         find.pro)
127
128 OUTPUTS:
129       s = string array.        out
130 COMMON BLOCKS:
131 NOTES:
132 MODIFICATION HISTORY:
133       R. Sterner, 20 Mar, 1990
134</div>
135
136         
137
138         
139            <h3>Parameters</h3>
140       
141           
142            <h4 id="_getfile_param_filein">filein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143             
144             
145             
146             
147             
148             
149             
150             
151            </h4>
152       
153          <div class="comments"></div>
154           
155
156         
157
158         
159
160            <h3>Keywords</h3>
161           
162            <h4 id="_getfile_keyword_error">error&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173            <div class="comments"></div>
174           
175            <h4 id="_getfile_keyword_help">help&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176             
177             
178             
179             
180             
181             
182             
183             
184            </h4>
185       
186            <div class="comments"></div>
187           
188            <h4 id="_getfile_keyword_quiet">quiet&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189             
190             
191             
192             
193             
194             
195             
196             
197            </h4>
198       
199            <div class="comments"></div>
200           
201            <h4 id="_getfile_keyword_find">find&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202             
203             
204             
205             
206             
207             
208             
209             
210            </h4>
211       
212            <div class="comments"></div>
213           
214         
215
216         
217         
218         
219         
220         
221         
222         
223         
224         
225         
226         
227         
228       
229         
230         
231         
232         
233         
234         
235         
236       
237         
238       
239        </div>
240       
241      </div>
242
243     
244
245      <div id="tagline">Produced by IDLdoc 2.0.</div>
246
247    </div>
248
249  </body>
250</html>
Note: See TracBrowser for help on using the repository browser.