Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/chkstru.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: 5.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>chkstru.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="chkstru.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 documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<< prev file \| <a href="extractstru.html">next file >></a>    <a href="chkstru.html" target="_TOP">view single page</a> \| <a href="./../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| routine    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">ToBeReviewed/STRUCTURE/</a></h1>
82	<h2 class="pro_file">chkstru.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="_chkstru">
103
104	<h2><a class="top" href="#container">top</a>chkstru </h2>
105
106	<p class="header">
107	<span class="result">result = </span>chkstru(<span class="result"><a href="#_chkstru_param_structure">structure</a>, <a href="#_chkstru_param_fields">fields</a></span>, <a href="#_chkstru_keyword_index">index</a>=<span class="result">index</span>, <a href="#_chkstru_keyword_verbose">verbose</a>=<span class="result">verbose</span>, <a href="#_chkstru_keyword_extract">extract</a>=<span class="result">extract</span>)</p>
108
109	<div class="comments">
110	NAME:
111	CHKSTRU (function)
112
113	PURPOSE:
114	check validity of a structure and test if necessary
115	fields are contained
116
117	CATEGORY:
118	tools
119
120	CALLING SEQUENCE:
121	res=CHKSTRU(STRUCTURE,FIELDS [,/VERBOSE])
122
123	INPUTS:
124	STRUCTURE --> the structure to be tested. If STRUCTURE is
125	not of type structure, the function will return 0
126
127	FIELDS --> a string or string array with field names to
128	be contained in STRUCTURE. CHKSTRU returns 1 (true)
129	only if all field names are contained in STRUCTURE.
130	The entries of FIELDS may be upper or lowercase.
131
132	KEYWORD PARAMETERS:
133	INDEX --> a named variable that will contain the indices of
134	the required field names in the structure. They can then
135	be assessed through structure.(index(i)) . Index will
136	contain -1 for all fields entries that are not in the
137	structure.
138
139	/VERBOSE --> set this keyword to return an error message
140	in case of an error.
141
142	/EXTRACT --> set this keyword to extract a fields from the
143	structure. -1 is return is fields or structure. are
144	incorrect.
145
146	OUTPUTS:
147	CHKSTRU returns 1 if successful, otherwise 0.
148
149	SUBROUTINES:
150
151	REQUIREMENTS:
152
153	NOTES:
154
155	EXAMPLE:
156	test = { a:1, b:2, c:3 }
157	required = ['a','c']
158	if CHKSTRU(test,required) then print,'found a and c.'
159	IDL> print, CHKSTRU(test,'b')
160	1
161	IDL> print, CHKSTRU(test,'b',/extract)
162	2
163
164	MODIFICATION HISTORY:
165	mgs, 02 Mar 1998: VERSION 1.00
166	mgs, 07 Apr 1998: - second parameter (FIELDS) now optional</div>
167
168
169
170
171	<h3>Parameters</h3>
172
173
174	<h4 id="_chkstru_param_structure">structure
175
176
177
178
179
180
181
182
183	</h4>
184
185	<div class="comments"></div>
186
187	<h4 id="_chkstru_param_fields">fields
188
189
190
191
192
193
194
195
196	</h4>
197
198	<div class="comments"></div>
199
200
201
202
203
204
205	<h3>Keywords</h3>
206
207	<h4 id="_chkstru_keyword_index">index
208
209
210
211
212
213
214
215
216	</h4>
217
218	<div class="comments"></div>
219
220	<h4 id="_chkstru_keyword_verbose">verbose
221
222
223
224
225
226
227
228
229	</h4>
230
231	<div class="comments"></div>
232
233	<h4 id="_chkstru_keyword_extract">extract
234
235
236
237
238
239
240
241
242	</h4>
243
244	<div class="comments"></div>
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271	</div>
272
273	</div>
274
275
276
277	<div id="tagline">Produced by IDLdoc 2.0.</div>
278
279	</div>
280
281	</body>
282	</html>

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

Download in other formats: