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

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

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 5.4 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 (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="createfunc.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" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Utilities//createfunc.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" 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" 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">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">
90 write an IDL function, compile it and execute it.
91 useful to avoid the use of execute
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_createfunc">
106
107          <h2><a class="top" href="#container">top</a>createfunc </h2>
108       
109          <p class="header">
110            <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>
111       
112          <div class="comments"></div>
113
114         
115
116         
117            <h3>Parameters</h3>
118       
119           
120            <h4 id="_createfunc_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121              <span class="attr">in</span>
122             
123             
124              <span class="attr">required</span>
125             
126             
127             
128             
129            </h4>
130       
131          <div class="comments"> 
132 a scalar string defining the result to be given back by the function.
133 (see examples)
134</div>
135           
136
137         
138
139         
140
141            <h3>Keywords</h3>
142           
143            <h4 id="_createfunc_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144              <span class="attr">in</span>
145             
146             
147             
148             
149             
150              <span class="attr">default:</span> <span class="value">for_createfunc.pro</span>
151             
152            </h4>
153       
154            <div class="comments">
155 name of the function to be created.
156</div>
157           
158            <h4 id="_createfunc_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159              <span class="attr">in</span>
160             
161             
162             
163             
164             
165             
166             
167            </h4>
168       
169            <div class="comments"> 
170 a vector string. to specify a list of keywords that must be included in the
171 function definition.
172 Warning: the string must start with a ','
173 for example: KWDLIST = ', TOTO = toto'
174</div>
175           
176            <h4 id="_createfunc_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179             
180             
181             
182             
183             
184             
185            </h4>
186       
187            <div class="comments"> 
188 used to pass your keywords to the created function.
189</div>
190           
191         
192
193          <h3>Examples</h3><div class="preformat">
194 IDL> print, createfunc('3*2', filename='test')
195 IDL> print, createfunc('3*two', filename = 'test' $
196 IDL>                          , kwdlist ='two = two', two = 2)
197</div>
198          <h3>Version history</h3>
199         
200          <h4>Version</h4><div class="preformat"> $Id: createfunc.pro 136 2006-07-10 15:20:19Z pinsard $
201</div>
202          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr)
203                      May 2005
204</div>
205         
206         
207          <h3>Known issues</h3>
208         
209         
210         
211          <h4>Restrictions</h4><div class="preformat">
212 - arguments can be given only through keywords;
213 - ends the function name with '.pro' if needed.
214</div>
215       
216         
217         
218         
219         
220         
221         
222         
223       
224          <h3>Statistics</h3>
225          <table class="statistics">
226            <tr><td>McCabe cyclic</td><td>           6</td></tr>
227            <tr><td>McCabe essential</td><td>           1</td></tr>
228            <tr><td>McCabe modular design</td><td>           1</td></tr>
229          </table>
230         
231       
232        </div>
233       
234      </div>
235
236     
237
238      <div id="tagline">Produced by IDLdoc 2.0.</div>
239
240    </div>
241
242  </body>
243</html>
Note: See TracBrowser for help on using the repository browser.