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

Last change on this file since 187 was 187, checked in by pinsard, 18 years ago

introducing hyperlinks in idldoc outputs (2/2)
File size: 4.2 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>KWDLIST</i>, <a href="#_createfunc_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
76
77   
78
79   
80
81   
82    <h3>Parameters</h3>
83   
84
85    <a name="#_createfunc_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     
93     
94     
95    </h4>
96
97     
98 a scalar string defining the result to be given back by the function.
99 (see examples)
100
101   
102   
103
104   
105    <h3>Keywords</h3>
106
107   
108    <a name="#_createfunc_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_createfunc.pro</i></font>
117     
118    </h4>
119
120   
121 name of the function to be created.
122
123   
124    <a name="#_createfunc_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     
132     
133     
134    </h4>
135
136     
137 a vector string. to specify a list of keywords that must be included in the
138 function definition.
139 Warning: the string must start with a ','
140 for example: KWDLIST = ', TOTO = toto'
141
142   
143    <a name="#_createfunc_keyword__EXTRA"></a>
144    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145     
146     
147     
148     
149     
150     
151     
152     
153    </h4>
154
155     
156 used to pass your keywords to the created function.
157
158   
159   
160
161    <h3>Examples</h3>
162 IDL> print, createfunc('3*2', filename='test')
163 IDL> print, createfunc('3*two', filename = 'test' $
164 IDL>                          , kwdlist ='two = two', two = 2)
165
166    <h3>Version history</h3>
167   
168    <h4>Version</h4> $Id: createfunc.pro 136 2006-07-10 15:20:19Z pinsard $
169
170    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
171                      May 2005
172
173   
174
175    <h3>Known issues</h3>
176   
177   
178   
179    <h4>Restrictions</h4>
180 - arguments can be given only through keywords;
181 - ends the function name with '.pro' if needed.
182
183
184   
185   
186   
187   
188   
189   
190   
191
192    <font size="-3"><p>&nbsp;</p></font>
193    <hr size="1" color="#CCCCCC"/>
194     
195
196   
197
198    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
199
200  </body>
201</html>
Note: See TracBrowser for help on using the repository browser.