source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/isadirectory.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 4.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>isadirectory.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="fitintobox.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="isafile.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>isadirectory.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 check if a directory exists and make sure that it ends
65 with the directory separator mark.
66
67
68   
69
70     
71      <a name="#_isadirectory"></a>
72
73      <h2>isadirectory  <font size="-1" color="#006633">
74 Input/Output
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>isadirectory(<i>[<a href="#_isadirectory_keyword_directoryin">directoryin</a>]</i>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<i>TITLE</i>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<i>IODIRECTORY</i>, <a href="#_isadirectory_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 the directory name
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_isadirectory_keyword_directoryin"></a>
91    <h4>directoryin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
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 proposed directory. If neither dirname
104 input parameter of IODIRECTORY keyword are defined,
105 we ask the user to choose a directory.
106
107   
108   
109
110   
111    <h3>Keywords</h3>
112
113   
114    <a name="#_isadirectory_keyword_TITLE"></a>
115    <h4>TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
116     
117     
118     
119     
120     
121     
122     
123     
124    </h4>
125
126   
127 the title of the window
128
129   
130    <a name="#_isadirectory_keyword_IODIRECTORY"></a>
131    <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132     
133     
134     
135     
136     
137     
138     
139     
140    </h4>
141
142   
143 a proposed directory
144
145   
146    <a name="#_isadirectory_keyword__EXTRA"></a>
147    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148     
149     
150     
151     
152     
153     
154     
155     
156    </h4>
157
158   
159 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/DIALOG_PICKFILE.html">DIALOG_PICKFILE</a>
160
161   
162   
163
164    <h3>Examples</h3><pre>
165
166 IDL> print, !dir
167    /usr/local/rsi/idl_6.0
168 IDL> print, isadirectory(!dir)
169    /usr/local/rsi/idl_6.0/
170 IDL> print, isadirectory(!dir+'notgood')
171
172    </pre><h3>Version history</h3>
173   
174    <h4>Version</h4>
175 $Id: isadirectory.pro 327 2007-12-13 16:22:35Z pinsard $
176
177    <h4>History</h4>
178 Sebastien Masson (smasson@lodyc.jussieu.fr)
179                      June 28, 2000
180 June 2005: Sebastien Masson: cleaning, use for file_* functions
181
182   
183
184   
185   
186   
187   
188   
189
190   
191   
192   
193   
194   
195   
196   
197
198    <font size="-3"><p>&nbsp;</p></font>
199    <hr size="1" color="#CCCCCC"/>
200     
201
202   
203
204    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
205
206  </body>
207</html>
Note: See TracBrowser for help on using the repository browser.