source: trunk/SRC/Documentation/idldoc_html_output/Utilities/createfunc.html @ 97

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

start to modify headers of Obsolete *.pro files for better idldoc output
File size: 5.1 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>createfunc.pro (IDLdoc API 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="createfunc.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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&lt;&lt; prev file | <a href="createpro.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="createfunc.html" 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">createfunc.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> write an idl function, compile it and execute it.
90 usefull to avoid the use of execute
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_createfunc">
105
106          <h2><a class="top" href="#container">top</a>createfunc </h2>
107       
108          <p class="header">
109            <span class="result">result = </span>createfunc(<span class="result"><a href="#_createfunc_param_command">command</a></span>, <a href="#_createfunc_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createfunc_keyword_KWDLIST">KWDLIST</a>=<span class="result">KWDLIST</span>, <a href="#_createfunc_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
110       
111          <div class="comments"></div>
112
113         
114
115         
116            <h3>Parameters</h3>
117       
118           
119            <h4 id="_createfunc_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
120              <span class="attr">in</span>
121             
122             
123              <span class="attr">required</span>
124             
125             
126             
127             
128            </h4>
129       
130          <div class="comments"> a scalar string defining the result to be byven back by the function. (see examples)
131</div>
132           
133
134         
135
136         
137
138            <h3>Keywords</h3>
139           
140            <h4 id="_createfunc_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144             
145             
146             
147             
148             
149            </h4>
150       
151            <div class="comments"> name of the funccedure to be created.
152      'for_createfunc.pro' by default</div>
153           
154            <h4 id="_createfunc_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155              <span class="attr">in</span>
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 function definition. Warning: the string
167      must start with a ',' for example: KWDLIST = ', TOTO = toto'
168</div>
169           
170            <h4 id="_createfunc_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171             
172             
173             
174             
175             
176             
177             
178             
179            </h4>
180       
181            <div class="comments"> used to pass your keywords to the created function.
182
183 SIDE EFFECTS: ends the function name with '.pro' if needed
184</div>
185           
186         
187
188          <h3>Examples</h3><div class="value"> 
189      IDL> print, createfunc('3*2', filename='test')
190      IDL> print, createfunc('3*two', filename = 'test' $
191                                    , kwdlist ='two = two', two = 2)
192</div>
193          <h3>Version history</h3>
194         
195         
196          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
197                      May 2005</div>
198         
199         
200          <h3>Known issues</h3>
201         
202         
203         
204          <h4>Restrictions</h4><div class="value"> arguments can be given only through keywords
205</div>
206       
207         
208         
209         
210         
211         
212         
213         
214       
215         
216       
217        </div>
218       
219      </div>
220
221     
222
223      <div id="tagline">Produced by IDLdoc 2.0.</div>
224
225    </div>
226
227  </body>
228</html>
Note: See TracBrowser for help on using the repository browser.