source: trunk/SRC/Documentation/idldoc_html_output/Utilities/isadirectory.html

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

update documentation
File size: 5.3 KB
RevLine 
[89]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>
[104]9    <title>isadirectory.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="isadirectory.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Utilities//isadirectory.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]74<a href="fitintobox.html">&lt;&lt;prev file</a> | <a href="isafile.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="isadirectory.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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Utilities/</a></h1>
[89]82      <h2 class="pro_file">isadirectory.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
90 check if a directory exists and make sure that it ends
91 with the directory separator mark.
[93]92</div>
[89]93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_isadirectory">
106
[234]107          <h2><a class="top" href="#container">top</a>isadirectory <span class="categories">
[338]108 Input/Output
[93]109</span></h2>
[89]110       
111          <p class="header">
[234]112            <span class="result">result = </span>isadirectory(<span class="result">[<a href="#_isadirectory_param_directoryin">directoryin</a>]</span>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isadirectory_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
[89]113       
[234]114          <div class="comments">
115</div>
[89]116
[234]117          <h3>Return value</h3><div class="preformat">
[138]118 the directory name
[89]119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_isadirectory_param_directoryin">directoryin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[93]126              <span class="attr">in</span>
[89]127             
[93]128              <span class="attr">optional</span>
[89]129             
130             
131             
132             
133             
134            </h4>
135       
[234]136          <div class="comments">
[138]137 a proposed directory. If neither dirname
138 input parameter of IODIRECTORY keyword are defined,
[242]139 we ask the user to choose a directory.
[93]140</div>
[89]141           
142
143         
144
145         
146
147            <h3>Keywords</h3>
148           
149            <h4 id="_isadirectory_keyword_TITLE">TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
151             
152             
153             
154             
155             
156             
157             
158            </h4>
159       
[234]160            <div class="comments">
[138]161 the title of the window
[93]162</div>
[89]163           
164            <h4 id="_isadirectory_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165             
166             
167             
168             
169             
170             
171             
172             
173            </h4>
174       
[234]175            <div class="comments">
[138]176 a proposed directory
[93]177</div>
[89]178           
[234]179            <h4 id="_isadirectory_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]180             
181             
182             
183             
184             
185             
186             
187             
188            </h4>
189       
[234]190            <div class="comments">
[338]191 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/DIALOG_PICKFILE.html">DIALOG_PICKFILE</a>
[118]192</div>
[89]193           
194         
195
[138]196          <h3>Examples</h3><div class="preformat">
[93]197
[402]198   IDL> print, !dir
[93]199    /usr/local/rsi/idl_6.0
[402]200   IDL> print, isadirectory(!dir)
[93]201    /usr/local/rsi/idl_6.0/
[402]202   IDL> print, isadirectory(!dir+'notgood')
[93]203</div>
204          <h3>Version history</h3>
[89]205         
[234]206          <h4>Version</h4><div class="preformat">
[402]207 $Id: isadirectory.pro 371 2008-08-07 09:32:02Z pinsard $
[242]208</div>
[234]209          <h4>History</h4><div class="preformat">
210 Sebastien Masson (smasson@lodyc.jussieu.fr)
[93]211                      June 28, 2000
[118]212 June 2005: Sebastien Masson: cleaning, use for file_* functions
213</div>
[89]214         
215         
216         
217         
218         
219         
220         
221       
222         
223         
224         
225         
226         
227         
228         
229       
[163]230          <h3>Statistics</h3>
231          <table class="statistics">
232            <tr><td>McCabe cyclic</td><td>          10</td></tr>
233            <tr><td>McCabe essential</td><td>           1</td></tr>
234            <tr><td>McCabe modular design</td><td>           1</td></tr>
235          </table>
[89]236         
237       
238        </div>
239       
240      </div>
241
242     
243
244      <div id="tagline">Produced by IDLdoc 2.0.</div>
245
246    </div>
247
248  </body>
[249]249</html>
Note: See TracBrowser for help on using the repository browser.