Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/isafile.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago
new idldoc html and assistant outputs
File size: 5.8 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>isafile.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="isadirectory.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="linearequation.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>isafile.pro</h2>
59
60	<dl>
61	</dl>
62
63
64	same as <a href=".//find.html">find</a> except that as long as the file is 'NOT FOUND',
65	isafile calls dialog_pickfile, to ask the user to select a file.
66
67
68
69
70
71	<a name="#_isafile"></a>
72
73	<h2>isafile <font size="-1" color="#006633">
74	io
75	</font></h2>
76
77	<p><font face="Courier"><i>result = </i>isafile(<i>[<a href="#_isafile_keyword_filein">filein</a>]</i>, <a href="#_isafile_keyword_FILENAME">FILENAME</a>=<i>FILENAME</i>, <a href="#_isafile_keyword_IODIRECTORY">IODIRECTORY</a>=<i>IODIRECTORY</i>, <a href="#_isafile_keyword_NEW">NEW</a>=<i>NEW</i>, <a href="#_isafile_keyword_RECURSIVE">RECURSIVE</a>=<i>RECURSIVE</i>, <a href="#_isafile_keyword_ONLYPRO">ONLYPRO</a>=<i>ONLYPRO</i>, <a href="#_isafile_keyword_ONLYNC">ONLYNC</a>=<i>ONLYNC</i>, <a href="#_isafile_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
78
79
80
81
82	<h3>Return value</h3>
83	the filename with its path
84
85
86
87	<h3>Parameters</h3>
88
89
90	<a name="#_isafile_keyword_filein"></a>
91	<h4>filein
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 name. If neither filein input parameter of filename keyword are
104	defined, the ask the user to choose a file.
105
106
107
108
109
110	<h3>Keywords</h3>
111
112
113	<a name="#_isafile_keyword_FILENAME"></a>
114	<h4>FILENAME
115
116
117
118
119
120
121
122
123	</h4>
124
125
126	a proposed filename.
127
128
129	<a name="#_isafile_keyword_IODIRECTORY"></a>
130	<h4>IODIRECTORY
131
132
133
134
135
136
137
138
139	</h4>
140
141
142	a directory where we look for the file. this
143	keyword is taken into account only if the dirname
144	of filein or filename is '.'
145
146
147	<a name="#_isafile_keyword_NEW"></a>
148	<h4>NEW
149
150
151
152
153
154
155
156
157	</h4>
158
159
160	to specify that filename is a new file and that we should check only its
161	path
162
163
164	<a name="#_isafile_keyword_RECURSIVE"></a>
165	<h4>RECURSIVE
166
167
168
169
170
171
172
173
174	</h4>
175
176
177	performs recursive searching of directory hierarchies.
178	In a recursive search, find looks recursively for any and all
179	subdirectories in the file hierarchy rooted at the IODIRECTORY argument.
180
181
182	<a name="#_isafile_keyword_ONLYPRO"></a>
183	<h4>ONLYPRO
184
185
186
187
188
189
190
191
192	</h4>
193
194
195	force to look only at file ending with .pro
196
197
198	<a name="#_isafile_keyword_ONLYNC"></a>
199	<h4>ONLYNC
200
201
202
203
204
205
206
207
208	</h4>
209
210
211	force to look only at file ending with .nc
212
213
214	<a name="#_isafile_keyword__EXTRA"></a>
215	<h4>_EXTRA
216
217
218
219
220
221
222
223
224	</h4>
225
226
227	Used to pass keywords
228
229	all find, file_search and dialog_pickfile keywords (like title) can be used
230
231
232
233
234	<h3>Examples</h3><pre>
235
236	IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro')
237	/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
238	IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD/Commons')
239	/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
240	IDL> print, isafile('cm_4mesh.pro', iodir = !path)
241	/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
242	IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD', /recursive)
243	/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
244	IDL> print, isafile('cm_4mesh.pro', iodir = getenv('HOME'), /recursive)
245	/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
246	IDL> print, isafile('fake_file.pro')
247
248	</pre><h3>Version history</h3>
249
250	<h4>Version</h4>
251	$Id: isafile.pro 232 2007-03-20 16:59:36Z pinsard $
252	<h4>History</h4>
253	Sebastien Masson (smasson@lodyc.jussieu.fr)
254	11/2/2000
255	June 2005: Sebastien Masson: cleaning, use for file_* functions
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273	<font size="-3"><p> </p></font>
274	<hr size="1" color="#CCCCCC"/>
275
276
277
278
279	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
280
281	</body>
282	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: