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

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 4.8 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>isadirectory.pro (IDLdoc API 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="isadirectory.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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="find.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?format=raw" 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?format=raw">Utilities/</a></h1>
82      <h2 class="pro_file">isadirectory.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_isadirectory">
103
104          <h2><a class="top" href="#container">top</a>isadirectory </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME:isadirectory
111
112 PURPOSE:check if a directory exists and make sure that it ends
113         with the directory separator mark.
114
115 CATEGORY: io
116
117 CALLING SEQUENCE: directory=isadirectory([dirname])
118 
119 INPUTS:optional:a proposed directory. If neither dirname
120        input parameter of IODIRECTORY keyword are defined,
121        the ask the user to choose a directory.
122
123 KEYWORD PARAMETERS:
124
125     IODIRECTORY:a proposed directory
126
127     TITLE = the title of the window
128
129     all dialog_pickfile keywords (like filter)
130
131 OUTPUTS: the directory name
132
133 COMMON BLOCKS:none
134
135 SIDE EFFECTS:
136
137 RESTRICTIONS:
138
139 EXAMPLE:
140
141    IDL> print, !dir
142    /usr/local/rsi/idl_6.0
143    IDL> print, isadirectory(!dir)
144    /usr/local/rsi/idl_6.0/
145    IDL> print, isadirectory(!dir+'notgood')
146</div>
147
148         
149
150         
151            <h3>Parameters</h3>
152       
153           
154            <h4 id="_isadirectory_param_directoryin">directoryin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155             
156             
157             
158             
159             
160             
161             
162             
163            </h4>
164       
165          <div class="comments"></div>
166           
167
168         
169
170         
171
172            <h3>Keywords</h3>
173           
174            <h4 id="_isadirectory_keyword_TITLE">TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181             
182             
183            </h4>
184       
185            <div class="comments"></div>
186           
187            <h4 id="_isadirectory_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
188             
189             
190             
191             
192             
193             
194             
195             
196            </h4>
197       
198            <div class="comments"></div>
199           
200            <h4 id="_isadirectory_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202             
203             
204             
205             
206             
207             
208             
209            </h4>
210       
211            <div class="comments"></div>
212           
213         
214
215         
216         
217         
218         
219         
220         
221         
222         
223         
224         
225         
226         
227       
228         
229         
230         
231         
232         
233         
234         
235       
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</html>
Note: See TracBrowser for help on using the repository browser.