source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/createfunc.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 4.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>createfunc.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=""><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="createpro.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>createfunc.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 write an IDL function, compile it and execute it.
65 useful to avoid the use of execute
66
67
68   
69
70     
71      <a name="#_createfunc"></a>
72
73      <h2>createfunc  </h2>
74
75      <p><font face="Courier"><i>result = </i>createfunc(<i><a href="#_createfunc_keyword_command">command</a></i>, <a href="#_createfunc_keyword_FILENAMEIN">FILENAMEIN</a>=<i>FILENAMEIN</i>, <a href="#_createfunc_keyword_KWDLIST">KWDLIST</a>=<i>vector string</i>, <a href="#_createfunc_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
76
77   
78
79
80   
81
82   
83    <h3>Parameters</h3>
84   
85
86    <a name="#_createfunc_keyword_command"></a>
87    <h4>command&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>scalar string</i></font>
94     
95     
96    </h4>
97
98   
99 defining the result to be given back by the function.
100 (see examples)
101
102   
103   
104
105   
106    <h3>Keywords</h3>
107
108   
109    <a name="#_createfunc_keyword_FILENAMEIN"></a>
110    <h4>FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111      <font size="-1" color="#006633">in</font>
112     
113     
114     
115     
116     
117      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>for_createfunc.pro</i></font>
118     
119    </h4>
120
121   
122 name of the function to be created.
123
124   
125    <a name="#_createfunc_keyword_KWDLIST"></a>
126    <h4>KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127      <font size="-1" color="#006633">in</font>
128     
129     
130     
131     
132      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector string</i></font>
133     
134     
135    </h4>
136
137     
138 to specify a list of keywords that must be included in the
139 function definition.
140 Warning: the string must start with a ','
141 for example: KWDLIST=', TOTO=toto'
142
143   
144    <a name="#_createfunc_keyword__EXTRA"></a>
145    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146     
147     
148     
149     
150     
151     
152     
153     
154    </h4>
155
156     
157 Used to pass keywords to the created function.
158
159   
160   
161
162    <h3>Examples</h3><pre>
163 IDL> print, createfunc('3*2', FILENAMEIN='test')
164 IDL> print, createfunc('3*two', FILENAMEIN='test' $
165 IDL>                          , KWDLIST='two = two', TWO=2)
166
167    </pre><h3>Version history</h3>
168   
169    <h4>Version</h4>
170 $Id: createfunc.pro 327 2007-12-13 16:22:35Z pinsard $
171
172    <h4>History</h4>
173 Sebastien Masson (smasson@lodyc.jussieu.fr)
174                      May 2005
175
176   
177
178    <h3>Known issues</h3>
179   
180   
181   
182    <h4>Restrictions</h4>
183 - arguments can be given only through keywords;
184 - ends the function name with '.pro' if needed.
185
186
187   
188   
189   
190   
191   
192   
193   
194
195    <font size="-3"><p>&nbsp;</p></font>
196    <hr size="1" color="#CCCCCC"/>
197     
198
199   
200
201    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
202
203  </body>
204</html>
Note: See TracBrowser for help on using the repository browser.