source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper2.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 6.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>ncdf_quickwrite_helper2.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="ncdf_quickwrite_helper1.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="ncdf_quickwrite_helper3.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ReadWrite/idl-NetCDF/ncdf_quickwrite/</font></h1>
58    <h2>ncdf_quickwrite_helper2.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67
68
69
70
71
72
73   
74    <h2>Routine summary</h2>
75
76    <dl>
77     
78      <dt><a href="#__str"><i>result = </i>_str(<i>string</i>)</a><dt>
79      <dd><font size="-1"></font></dd>
80     
81      <dt><a href="#_ncdf_quickwrite_typename"><i>result = </i>ncdf_quickwrite_typename(<i>num, name</i>)</a><dt>
82      <dd><font size="-1"></font></dd>
83     
84      <dt><a href="#_ncdf_quickwrite_helper2">ncdf_quickwrite_helper2<i>, ncfilename, s, sname</i></a><dt>
85      <dd><font size="-1"></font></dd>
86     
87    </dl>
88
89    <p>&nbsp;</p>
90   
91
92     
93      <a name="#__str"></a>
94
95      <h2>_str  <font size="-1" color="#006633">
96
97</font></h2>
98
99      <p><font face="Courier"><i>result = </i>_str(<i><a href="#__str_keyword_string">string</a></i>)</font></p>
100
101   
102
103    <h3>Return value</h3>
104
105
106
107   
108    <h3>Parameters</h3>
109   
110
111    <a name="#__str_keyword_string"></a>
112    <h4>string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113     
114     
115     
116     
117     
118     
119     
120     
121    </h4>
122
123   
124 String to be split. Contains text after in, out token on output.
125 
126
127   
128   
129
130   
131
132    <h3>Examples</h3>
133 
134 
135    <h3>Version history</h3>
136   
137    <h4>Version</h4>
138 $Id: ncdf_quickwrite_helper2.pro 157 2006-08-21 09:01:50Z navarro $
139
140    <h4>History</h4>
141
142
143   
144
145    <h3>Known issues</h3>
146   
147   
148   
149    <h4>Restrictions</h4>
150
151
152
153   
154   
155   
156   
157   
158   
159   
160
161    <font size="-3"><p>&nbsp;</p></font>
162    <hr size="1" color="#CCCCCC"/>
163     
164      <a name="#_ncdf_quickwrite_typename"></a>
165
166      <h2>ncdf_quickwrite_typename  <font size="-1" color="#006633">
167
168</font></h2>
169
170      <p><font face="Courier"><i>result = </i>ncdf_quickwrite_typename(<i><a href="#_ncdf_quickwrite_typename_keyword_num">num</a>, <a href="#_ncdf_quickwrite_typename_keyword_name">name</a></i>)</font></p>
171
172   
173
174    <h3>Return value</h3>
175
176
177
178   
179    <h3>Parameters</h3>
180   
181
182    <a name="#_ncdf_quickwrite_typename_keyword_num"></a>
183    <h4>num&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184     
185     
186     
187     
188     
189     
190     
191     
192    </h4>
193
194   
195
196
197   
198
199    <a name="#_ncdf_quickwrite_typename_keyword_name"></a>
200    <h4>name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201     
202     
203     
204     
205     
206      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
207     
208     
209    </h4>
210
211   
212 It is a string giving the name of the file to be opened. If NAME does not contain
213 the separating character of directories ('/' under unix for example), the file
214 will be looked for in the current directory.
215 
216
217   
218   
219
220   
221
222    <h3>Examples</h3>
223 
224 
225    <h3>Version history</h3>
226   
227    <h4>Version</h4>
228 $Id: ncdf_quickwrite_helper2.pro 157 2006-08-21 09:01:50Z navarro $
229
230    <h4>History</h4>
231
232
233   
234
235    <h3>Known issues</h3>
236   
237   
238   
239    <h4>Restrictions</h4>
240
241
242
243   
244   
245   
246   
247   
248   
249   
250
251    <font size="-3"><p>&nbsp;</p></font>
252    <hr size="1" color="#CCCCCC"/>
253     
254      <a name="#_ncdf_quickwrite_helper2"></a>
255
256      <h2>ncdf_quickwrite_helper2  <font size="-1" color="#006633">
257
258</font></h2>
259
260      <p><font face="Courier">ncdf_quickwrite_helper2<i>, <a href="#_ncdf_quickwrite_helper2_keyword_ncfilename">ncfilename</a>, <a href="#_ncdf_quickwrite_helper2_keyword_s">s</a>, <a href="#_ncdf_quickwrite_helper2_keyword_sname">sname</a></i></font></p>
261
262   
263
264    <h3>Return value</h3>
265
266
267
268   
269    <h3>Parameters</h3>
270   
271
272    <a name="#_ncdf_quickwrite_helper2_keyword_ncfilename"></a>
273    <h4>ncfilename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
274     
275     
276     
277     
278     
279     
280     
281     
282    </h4>
283
284   
285
286
287   
288
289    <a name="#_ncdf_quickwrite_helper2_keyword_s"></a>
290    <h4>s&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
291     
292     
293     
294     
295     
296     
297     
298     
299    </h4>
300
301   
302 The string to be searched
303
304   
305
306    <a name="#_ncdf_quickwrite_helper2_keyword_sname"></a>
307    <h4>sname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
308     
309     
310     
311     
312     
313     
314     
315     
316    </h4>
317
318   
319 
320
321   
322   
323
324   
325
326    <h3>Examples</h3>
327 
328 
329    <h3>Version history</h3>
330   
331    <h4>Version</h4>
332 $Id: ncdf_quickwrite_helper2.pro 157 2006-08-21 09:01:50Z navarro $
333
334    <h4>History</h4>
335
336
337   
338
339    <h3>Known issues</h3>
340   
341   
342   
343    <h4>Restrictions</h4>
344
345
346
347   
348   
349   
350   
351   
352   
353   
354
355    <font size="-3"><p>&nbsp;</p></font>
356    <hr size="1" color="#CCCCCC"/>
357     
358
359   
360
361    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:35 2006.</font></p>
362
363  </body>
364</html>
Note: See TracBrowser for help on using the repository browser.