1 | |
---|
2 | |
---|
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
4 | <head> |
---|
5 | <title>routine_name.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="report.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="testvar.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>routine_name.pro</h2> |
---|
59 | |
---|
60 | <dl> |
---|
61 | </dl> |
---|
62 | |
---|
63 | |
---|
64 | Give us the name of the routine (procedure or function) where we are. |
---|
65 | |
---|
66 | |
---|
67 | |
---|
68 | |
---|
69 | |
---|
70 | <a name="#_routine_name"></a> |
---|
71 | |
---|
72 | <h2>routine_name <font size="-1" color="#006633"> |
---|
73 | Utilities |
---|
74 | </font></h2> |
---|
75 | |
---|
76 | <p><font face="Courier"><i>result = </i>routine_name(<i>[<a href="#_routine_name_keyword_pilingnum">pilingnum</a>]</i>)</font></p> |
---|
77 | |
---|
78 | |
---|
79 | |
---|
80 | |
---|
81 | <h3>Return value</h3> |
---|
82 | a string giving either the full name of the routine (with the path) or |
---|
83 | '$MAIN$' |
---|
84 | |
---|
85 | |
---|
86 | |
---|
87 | <h3>Parameters</h3> |
---|
88 | |
---|
89 | |
---|
90 | <a name="#_routine_name_keyword_pilingnum"></a> |
---|
91 | <h4>pilingnum |
---|
92 | <font size="-1" color="#006633">in</font> |
---|
93 | |
---|
94 | <font size="-1" color="#006633">optional</font> |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | </h4> |
---|
101 | |
---|
102 | |
---|
103 | A whole number which give us how many level we have to reascend |
---|
104 | in the piling up of routines and subroutines to find the looked for routine. |
---|
105 | |
---|
106 | |
---|
107 | |
---|
108 | |
---|
109 | |
---|
110 | |
---|
111 | <h3>Examples</h3><pre> |
---|
112 | |
---|
113 | IDL> print, routine_name() |
---|
114 | /usr1/com/smasson/IDL_RD/UTILITAIRE/report.pro |
---|
115 | IDL> print, routine_name(1) |
---|
116 | /usr1/com/smasson/IDL_RD/PLOTS/DIVERS/determineminmax.pro |
---|
117 | IDL> print, routine_name(2) |
---|
118 | /usr1/com/smasson/IDL_RD/PLOTS/DESSINE/plt.pro |
---|
119 | IDL> print, routine_name(3) |
---|
120 | $MAIN$ |
---|
121 | IDL> print, routine_name(4) |
---|
122 | $MAIN$ |
---|
123 | |
---|
124 | </pre><h3>Version history</h3> |
---|
125 | |
---|
126 | <h4>Version</h4> |
---|
127 | $Id: routine_name.pro 386 2008-12-03 13:26:28Z smasson $ |
---|
128 | |
---|
129 | <h4>History</h4> |
---|
130 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
131 | 21/10/1999 |
---|
132 | |
---|
133 | |
---|
134 | |
---|
135 | <h3>Known issues</h3> |
---|
136 | |
---|
137 | |
---|
138 | |
---|
139 | <h4>Restrictions</h4> |
---|
140 | This function use the keyword OUTPUT in <a href="/Applications/itt/idl64/help/online_help/HELP.html">HELP</a> and |
---|
141 | it is specified |
---|
142 | in the on-line help that the return syntax of this word can change in |
---|
143 | function of the version of the code. This version works with IDL 5.2. |
---|
144 | |
---|
145 | |
---|
146 | |
---|
147 | |
---|
148 | |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | <font size="-3"><p> </p></font> |
---|
155 | <hr size="1" color="#CCCCCC"/> |
---|
156 | |
---|
157 | |
---|
158 | |
---|
159 | |
---|
160 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
161 | |
---|
162 | </body> |
---|
163 | </html> |
---|