source: trunk/SRC/Documentation/idldoc_html_output/Utilities/routine_name.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 4.7 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>routine_name.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="routine_name.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//routine_name.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<a href="report.html">&lt;&lt;prev file</a> | <a href="testvar.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="routine_name.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">routine_name.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Give us the name of the routine (procedure or function) where we are.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_routine_name">
105
106          <h2><a class="top" href="#container">top</a>routine_name <span class="categories">
107 Utilities
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>routine_name(<span class="result">[<a href="#_routine_name_param_pilingnum">pilingnum</a>]</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 a string giving either the full name of the routine (with the path) or
118 '$MAIN$'
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_routine_name_param_pilingnum">pilingnum&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128              <span class="attr">optional</span>
129             
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 A whole number which give us how many level we have to reascend
138 in the piling up of routines and subroutines to find the looked for routine.
139</div>
140           
141
142         
143
144         
145
146          <h3>Examples</h3><div class="preformat">
147
148   IDL> print, routine_name()
149  /usr1/com/smasson/IDL_RD/UTILITAIRE/report.pro
150   IDL> print, routine_name(1)
151  /usr1/com/smasson/IDL_RD/PLOTS/DIVERS/determineminmax.pro
152   IDL> print, routine_name(2)
153  /usr1/com/smasson/IDL_RD/PLOTS/DESSINE/plt.pro
154   IDL> print, routine_name(3)
155  $MAIN$
156   IDL> print, routine_name(4)
157  $MAIN$
158</div>
159          <h3>Version history</h3>
160         
161          <h4>Version</h4><div class="preformat">
162 $Id: routine_name.pro 386 2008-12-03 13:26:28Z smasson $
163</div>
164          <h4>History</h4><div class="preformat">
165 Sebastien Masson (smasson@lodyc.jussieu.fr)
166                      21/10/1999
167</div>
168         
169         
170          <h3>Known issues</h3>
171         
172         
173         
174          <h4>Restrictions</h4><div class="preformat">
175 This function use the keyword OUTPUT in <a href="/Applications/itt/idl64/help/online_help/HELP.html">HELP</a> and
176 it is specified
177 in the on-line help that the return syntax of this word can change in
178 function of the version of the code. This version works with IDL 5.2.
179</div>
180       
181         
182         
183         
184         
185         
186         
187         
188       
189          <h3>Statistics</h3>
190          <table class="statistics">
191            <tr><td>McCabe cyclic</td><td>           9</td></tr>
192            <tr><td>McCabe essential</td><td>           1</td></tr>
193            <tr><td>McCabe modular design</td><td>           1</td></tr>
194          </table>
195         
196       
197        </div>
198       
199      </div>
200
201     
202
203      <div id="tagline">Produced by IDLdoc 2.0.</div>
204
205    </div>
206
207  </body>
208</html>
Note: See TracBrowser for help on using the repository browser.