source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/protype.html @ 242

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers + replace some message by some report
File size: 3.1 KB
RevLine 
[163]1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>protype.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%">
[177]48<a href="mergeonline_help.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
[163]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="pwd.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>protype.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 test is a ".pro" file corresponds to an IDL procedure, function or batch file.
65
66
67   
68
69     
70      <a name="#_protype"></a>
71
[234]72      <h2>protype  <font size="-1" color="#006633">
[163]73 Utilities
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>protype(<i><a href="#_protype_keyword_file">file</a></i>)</font></p>
77
78   
79
[234]80
81    <h3>Return value</h3>
82 -1 if not found
[163]83 A scalar of string type: 'proc', 'func' or 'batch'
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_protype_keyword_file"></a>
91    <h4>file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
[234]95      <font size="-1" color="#006633">required</font>
[163]96     
[234]97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
[163]98     
99     
100    </h4>
101
[234]102   
103 the name of the ".pro" file to be tested.
[163]104 if necessary, the input name is completed with '.pro'
105 and its path found in !path
106
107   
108   
109
110   
111
[234]112    <h3>Examples</h3><pre>
[163]113
114 IDL> print, protype('protype')
115      func
116 IDL> print, protype('protype.pro')
117      func
118 IDL> print, protype('init')
119      batch
120 IDL> print, protype('plt')
121      proc
122
[234]123    </pre><h3>Version history</h3>
[163]124   
[234]125    <h4>Version</h4>
126 $Id: protype.pro 231 2007-03-19 17:15:51Z pinsard $
[242]127
[234]128    <h4>History</h4>
129 Sebastien Masson (smasson@lodyc.jussieu.fr)
[163]130                       Feb 2006
131
132   
133
134   
135   
136   
137   
138   
139
140   
141   
142   
143   
144   
145   
146   
147
148    <font size="-3"><p>&nbsp;</p></font>
149    <hr size="1" color="#CCCCCC"/>
150     
151
152   
153
[187]154    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]155
156  </body>
[234]157</html>
Note: See TracBrowser for help on using the repository browser.