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

Last change on this file since 200 was 200, checked in by smasson, 18 years ago

update idldoc documentation

File size: 2.9 KB
Line 
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%">
48<a href="mergeonline_help.html"><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="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
72      <h2>protype  <font size="-1" color="#006633"> 
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
80    <h3>Return value</h3> 
81 A scalar of string type: 'proc', 'func' or 'batch'
82
83
84   
85    <h3>Parameters</h3>
86   
87
88    <a name="#_protype_keyword_file"></a>
89    <h4>file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
90      <font size="-1" color="#006633">in</font>
91     
92     
93     
94     
95     
96     
97     
98    </h4>
99
100     
101 A scalar of string type, the name of the ".pro" file to be tested
102 if necessary, the input name is completed with '.pro'
103 and its path found in !path
104
105   
106   
107
108   
109
110    <h3>Examples</h3>
111
112 IDL> print, protype('protype')
113      func
114 IDL> print, protype('protype.pro')
115      func
116 IDL> print, protype('init')
117      batch
118 IDL> print, protype('plt')
119      proc
120
121    <h3>Version history</h3>
122   
123    <h4>Version</h4> $Id: protype.pro 163 2006-08-29 12:59:46Z navarro $
124    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
125                       Feb 2006
126
127   
128
129   
130   
131   
132   
133   
134
135   
136   
137   
138   
139   
140   
141   
142
143    <font size="-3"><p>&nbsp;</p></font>
144    <hr size="1" color="#CCCCCC"/>
145     
146
147   
148
149    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
150
151  </body>
152</html>
Note: See TracBrowser for help on using the repository browser.