source: trunk/SRC/Documentation/idldoc_html_output/Utilities/createpro.html @ 107

Last change on this file since 107 was 107, checked in by smasson, 18 years ago

bugfix in ead/write_oasis
File size: 5.6 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>createpro.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="createpro.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?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="createfunc.html">&lt;&lt;prev file</a> | <a href="def_myuniquetmpdir.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="createpro.html?format=raw" 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">Utilities/</a></h1>
82      <h2 class="pro_file">createpro.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> write an idl procedure, compile it and execute it.
90</div>
91
92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_createpro">
104
105          <h2><a class="top" href="#container">top</a>createpro </h2>
106       
107          <p class="header">
108            createpro<span class="result">, <a href="#_createpro_param_command">command</a></span>, <a href="#_createpro_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createpro_keyword_KWDLIST">KWDLIST</a>=<span class="result">KWDLIST</span>, <a href="#_createpro_keyword_KWDUSED">KWDUSED</a>=<span class="result">KWDUSED</span>, <a href="#_createpro_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
109       
110          <div class="comments"></div>
111
112         
113
114         
115            <h3>Parameters</h3>
116       
117           
118            <h4 id="_createpro_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
119              <span class="attr">in</span>
120             
121             
122              <span class="attr">required</span>
123             
124             
125             
126             
127            </h4>
128       
129          <div class="comments"> a string array defining the procedure to be created. each element will be a line of the created procedure.
130</div>
131           
132
133         
134
135         
136
137            <h3>Keywords</h3>
138           
139            <h4 id="_createpro_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140             
141             
142             
143             
144             
145             
146             
147             
148            </h4>
149       
150            <div class="comments"> name of the procedure to be created.
151      'for_createpro.pro' by default
152</div>
153           
154            <h4 id="_createpro_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155             
156             
157             
158             
159             
160             
161             
162             
163            </h4>
164       
165            <div class="comments"> a vector string. to specify a list of keywords that
166      must be included in the procedure definition. Warning: the string
167      must start with a ',' for example: KWDLIST = ', TOTO = toto'
168</div>
169           
170            <h4 id="_createpro_keyword_KWDUSED">KWDUSED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171             
172             
173             
174             
175             
176             
177             
178             
179            </h4>
180       
181            <div class="comments"></div>
182           
183            <h4 id="_createpro_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184             
185             
186             
187             
188             
189             
190             
191             
192            </h4>
193       
194            <div class="comments"> used to pass your keywords to the created procedure.
195
196 SIDE EFFECTS: ends the procedure name with '.pro' if needed
197</div>
198           
199         
200
201          <h3>Examples</h3><div class="value"> 
202      IDL> createpro, ['print,''OK'''], filename='test'
203      IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
204      IDL>   , filename = 'test', kwdlist =', ok = ok'
205      IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
206      IDL>   , filename = 'test', kwdlist = ', ok = ok', /ok
207
208</div>
209          <h3>Version history</h3>
210         
211         
212          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
213 cleaning + new keywords: October 2005
214 Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute</div>
215         
216         
217          <h3>Known issues</h3>
218         
219         
220         
221          <h4>Restrictions</h4><div class="value"> is not working with functions, use createfunc instead.
222              arguments can be given only through keywords
223</div>
224       
225         
226         
227         
228         
229         
230         
231         
232       
233         
234       
235        </div>
236       
237      </div>
238
239     
240
241      <div id="tagline">Produced by IDLdoc 2.0.</div>
242
243    </div>
244
245  </body>
246</html>
Note: See TracBrowser for help on using the repository browser.