source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/putfile.html @ 290

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

update documentation
File size: 5.1 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>putfile.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="putfile.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/STRING//putfile.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="nwrds.html">&lt;&lt;prev file</a> | <a href="str_size.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="putfile.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/STRING/</a></h1>
82      <h2 class="pro_file">putfile.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Write a text file from a string array.
91 </div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_putfile">
105
106          <h2><a class="top" href="#container">top</a>putfile <span class="categories">
107</span></h2>
108       
109          <p class="header">
110            putfile<span class="result">, <a href="#_putfile_param_file">file</a>, <a href="#_putfile_param_s">s</a></span>, <a href="#_putfile_keyword_ERROR">ERROR</a>=<span class="result">ERROR</span>, <a href="#_putfile_keyword_HELP">HELP</a>=<span class="result">HELP</span></p>
111       
112          <div class="comments">
113</div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_putfile_param_file">file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124             
125              <span class="attr">required</span>
126             
127              <span class="attr">type:</span> <span class="value">string</span>
128             
129             
130            </h4>
131       
132          <div class="comments">
133 = text file name.
134</div>
135           
136            <h4 id="_putfile_param_s">s&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
137              <span class="attr">in</span>
138             
139             
140              <span class="attr">required</span>
141             
142              <span class="attr">type:</span> <span class="value">string or array</span>
143             
144             
145            </h4>
146       
147          <div class="comments">
148 = string array.
149</div>
150           
151
152         
153
154         
155
156            <h3>Keywords</h3>
157           
158            <h4 id="_putfile_keyword_ERROR">ERROR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159             
160             
161             
162             
163             
164             
165             
166             
167            </h4>
168       
169            <div class="comments">
170 =err  error flag: 0=ok, 1=invalid string array.
171 </div>
172           
173            <h4 id="_putfile_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174             
175             
176             
177             
178             
179             
180             
181             
182            </h4>
183       
184            <div class="comments"></div>
185           
186         
187
188         
189          <h3>Version history</h3>
190         
191          <h4>Version</h4><div class="preformat">
192 $Id: putfile.pro 262 2007-08-21 14:19:32Z pinsard $
193</div>
194          <h4>History</h4><div class="preformat">
195       R. Sterner, 20 Mar, 1990
196       R. Sterner,  4 Nov, 1992 --- allowed scalar strings.
197
198 Copyright (C) 1990, Johns Hopkins University/Applied Physics Laboratory
199 This software may be used, copied, or redistributed as long as it is not
200 sold and this copyright notice is reproduced on each copy made.  This
201 routine is provided as is without any express or implied warranties
202 whatsoever.  Other limitations apply as described in the file disclaimer.txt.
203</div>
204         
205         
206         
207         
208         
209         
210         
211       
212         
213         
214         
215         
216         
217         
218         
219       
220          <h3>Statistics</h3>
221          <table class="statistics">
222            <tr><td>McCabe cyclic</td><td>           6</td></tr>
223            <tr><td>McCabe essential</td><td>           1</td></tr>
224            <tr><td>McCabe modular design</td><td>           1</td></tr>
225          </table>
226         
227       
228        </div>
229       
230      </div>
231
232     
233
234      <div id="tagline">Produced by IDLdoc 2.0.</div>
235
236    </div>
237
238  </body>
239</html>
Note: See TracBrowser for help on using the repository browser.