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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
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 all dialog_pickfile keywords (like filter) can be used.
69
70
71   
72
73     
74      <a name="#_isadirectory"></a>
75
76      <h2>isadirectory  <font size="-1" color="#006633"> io
77</font></h2>
78
79      <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>
80
81   
82
83    <h3>Return value</h3> 
84 the directory name
85
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_isadirectory_keyword_directoryin"></a>
92    <h4>directoryin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93      <font size="-1" color="#006633">in</font>
94     
95      <font size="-1" color="#006633">optional</font>
96     
97     
98     
99     
100     
101    </h4>
102
103     
104 a proposed directory. If neither dirname
105 input parameter of IODIRECTORY keyword are defined,
106 the ask the user to choose a directory.
107
108   
109   
110
111   
112    <h3>Keywords</h3>
113
114   
115    <a name="#_isadirectory_keyword_TITLE"></a>
116    <h4>TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
117     
118     
119     
120     
121     
122     
123     
124     
125    </h4>
126
127     
128 the title of the window
129
130   
131    <a name="#_isadirectory_keyword_IODIRECTORY"></a>
132    <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
133     
134     
135     
136     
137     
138     
139     
140     
141    </h4>
142
143     
144 a proposed directory
145
146   
147    <a name="#_isadirectory_keyword__extra"></a>
148    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149     
150     
151     
152     
153     
154     
155     
156     
157    </h4>
158
159     
160 used to pass your keywords
161
162   
163   
164
165    <h3>Examples</h3>
166
167 IDL> print, !dir
168    /usr/local/rsi/idl_6.0
169 IDL> print, isadirectory(!dir)
170    /usr/local/rsi/idl_6.0/
171 IDL> print, isadirectory(!dir+'notgood')
172
173    <h3>Version history</h3>
174   
175    <h4>Version</h4> $Id: isadirectory.pro 136 2006-07-10 15:20:19Z pinsard $
176    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
177                      June 28, 2000
178 June 2005: Sebastien Masson: cleaning, use for file_* functions
179
180   
181
182   
183   
184   
185   
186   
187
188   
189   
190   
191   
192   
193   
194   
195
196    <font size="-3"><p>&nbsp;</p></font>
197    <hr size="1" color="#CCCCCC"/>
198     
199
200   
201
202    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:56 2006.</font></p>
203
204  </body>
205</html>
Note: See TracBrowser for help on using the repository browser.