source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/putfile.html @ 402

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

update documentation
File size: 3.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>putfile.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="nwrds.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="str_size.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRING/</font></h1>
58    <h2>putfile.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Write a text file from a string array.
65 
66
67   
68
69     
70      <a name="#_putfile"></a>
71
72      <h2>putfile  <font size="-1" color="#006633">
73</font></h2>
74
75      <p><font face="Courier">putfile<i>, <a href="#_putfile_keyword_file">file</a>, <a href="#_putfile_keyword_s">s</a></i>, <a href="#_putfile_keyword_ERROR">ERROR</a>=<i>ERROR</i>, <a href="#_putfile_keyword_HELP">HELP</a>=<i>HELP</i></font></p>
76
77   
78
79
80   
81
82   
83    <h3>Parameters</h3>
84   
85
86    <a name="#_putfile_keyword_file"></a>
87    <h4>file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
88      <font size="-1" color="#006633">in</font>
89     
90     
91      <font size="-1" color="#006633">required</font>
92     
93      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
94     
95     
96    </h4>
97
98   
99 text file name.
100
101   
102
103    <a name="#_putfile_keyword_s"></a>
104    <h4>s&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
105      <font size="-1" color="#006633">in</font>
106     
107     
108      <font size="-1" color="#006633">required</font>
109     
110      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string or array</i></font>
111     
112     
113    </h4>
114
115   
116 string array.
117
118   
119   
120
121   
122    <h3>Keywords</h3>
123
124   
125    <a name="#_putfile_keyword_ERROR"></a>
126    <h4>ERROR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127     
128     
129     
130     
131     
132     
133     
134     
135    </h4>
136
137   
138 error flag: 0=ok, 1=invalid string array.
139 
140   
141    <a name="#_putfile_keyword_HELP"></a>
142    <h4>HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143     
144     
145     
146     
147     
148     
149     
150     
151    </h4>
152
153   
154   
155   
156
157   
158    </pre><h3>Version history</h3>
159   
160    <h4>Version</h4>
161 $Id: putfile.pro 374 2008-08-08 15:12:27Z pinsard $
162
163    <h4>History</h4>
164  - R. Sterner, 20 Mar, 1990
165  - R. Sterner,  4 Nov, 1992 --- allowed scalar strings.
166
167 Copyright (C) 1990, Johns Hopkins University/Applied Physics Laboratory
168 This software may be used, copied, or redistributed as long as it is not
169 sold and this copyright notice is reproduced on each copy made.  This
170 routine is provided as is without any express or implied warranties
171 whatsoever.  Other limitations apply as described in the file disclaimer.txt.
172
173   
174
175   
176   
177   
178   
179   
180
181   
182   
183   
184   
185   
186   
187   
188
189    <font size="-3"><p>&nbsp;</p></font>
190    <hr size="1" color="#CCCCCC"/>
191     
192
193   
194
195    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
196
197  </body>
198</html>
Note: See TracBrowser for help on using the repository browser.