source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/createpro.html @ 402

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

update documentation
File size: 5.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>createpro.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="createfunc.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="def_myuniquetmpdir.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>createpro.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 write an idl procedure, compile it and execute it.
65
66
67   
68
69     
70      <a name="#_createpro"></a>
71
72      <h2>createpro  </h2>
73
74      <p><font face="Courier">createpro<i>, <a href="#_createpro_keyword_command">command</a></i>, <a href="#_createpro_keyword_FILENAMEIN">FILENAMEIN</a>=<i>FILENAMEIN</i>, <a href="#_createpro_keyword_KWDLIST">KWDLIST</a>=<i>vector string</i>, <a href="#_createpro_keyword_KWDUSED">KWDUSED</a>=<i>KWDUSED</i>, <a href="#_createpro_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
75
76   
77
78
79   
80
81   
82    <h3>Parameters</h3>
83   
84
85    <a name="#_createpro_keyword_command"></a>
86    <h4>command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
87      <font size="-1" color="#006633">in</font>
88     
89     
90      <font size="-1" color="#006633">required</font>
91     
92      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string array</i></font>
93     
94     
95    </h4>
96
97   
98 array defining the procedure to be created.
99 each element will be a line of the created procedure.
100
101   
102   
103
104   
105    <h3>Keywords</h3>
106
107   
108    <a name="#_createpro_keyword_FILENAMEIN"></a>
109    <h4>FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113     
114     
115     
116      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>for_createpro.pro</i></font>
117     
118    </h4>
119
120   
121 name of the procedure to be created.
122
123   
124    <a name="#_createpro_keyword_KWDLIST"></a>
125    <h4>KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126      <font size="-1" color="#006633">in</font>
127     
128     
129     
130     
131      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector string</i></font>
132     
133     
134    </h4>
135
136   
137 to specify a list of keywords that must be included in the procedure
138 definition.
139
140 Warning: the string must start with a ','
141 for example: KWDLIST=', TOTO = toto'
142
143   
144    <a name="#_createpro_keyword_KWDUSED"></a>
145    <h4>KWDUSED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146     
147     
148     
149     
150     
151     
152     
153     
154    </h4>
155
156     
157 obsolete, please pass directly your keywords through _EXTRA
158
159   
160    <a name="#_createpro_keyword__EXTRA"></a>
161    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162     
163     
164     
165     
166     
167     
168     
169     
170    </h4>
171
172     
173 Used to pass keywords to the created procedure.
174
175   
176   
177
178    <h3>Examples</h3><pre>
179
180   IDL> createpro, ['print,''OK'''], FILENAMEIN='test'
181   IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
182   IDL>   , FILENAMEIN='test', KWDLIST =', ok = ok'
183   IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
184   IDL>   , FILENAMEIN='test', KWDLIST= ', ok = ok', /ok
185
186    </pre><h3>Version history</h3>
187   
188    <h4>Version</h4>
189 $Id: createpro.pro 375 2008-08-08 15:55:40Z pinsard $
190
191    <h4>History</h4>
192 Sebastien Masson (smasson@lodyc.jussieu.fr)
193  - cleaning + new keywords: October 2005
194  - Feb. 2006: supress keyword "kwdused" and use call_procedure instead of
195    execute
196
197   
198
199    <h3>Known issues</h3>
200   
201   
202   
203    <h4>Restrictions</h4>
204 - is not working with functions, use <a href="..//Utilities/createfunc.html">createfunc</a> instead.
205 - arguments can be given only through keywords.
206 - ends the procedure name with '.pro' if needed.
207
208
209   
210   
211   
212   
213   
214   
215   
216
217    <font size="-3"><p>&nbsp;</p></font>
218    <hr size="1" color="#CCCCCC"/>
219     
220
221   
222
223    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
224
225  </body>
226</html>
Note: See TracBrowser for help on using the repository browser.