- Timestamp:
- 07/23/09 11:18:49 (15 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/chkstru.html
r338 r402 115 115 116 116 <h3>Return value</h3><div class="preformat"> 117 CHKSTRU returns1 if successful, otherwise 0.117 1 if successful, otherwise 0. 118 118 </div> 119 119 … … 151 151 <div class="comments"> 152 152 A string or string array with field names to 153 be contained in STRUCTURE. CHKSTRU returns 1 (true) 154 only if all field names are contained in STRUCTURE. 153 be contained in STRUCTURE. 154 155 CHKSTRU returns 1 (true) only if all field names are contained in STRUCTURE. 156 155 157 The entries of FIELDS may be upper or lowercase. 156 158 </div> … … 176 178 <div class="comments"> 177 179 A named variable that will contain the indices of 178 the required field names in the structure. They can then 179 be assessed through structure.(index[i]) . Index will 180 contain -1 for all fields entries that are not in the 181 structure. 180 the required field names in the structure. 181 182 They can then be assessed through structure.(index[i]). 183 184 Index will contain -1 for all fields entries that are not in the structure. 182 185 </div> 183 186 … … 194 197 195 198 <div class="comments"> 196 set this keyword to return an error message 197 in case of an error. 199 set this keyword to return an error message in case of an error. 198 200 </div> 199 201 … … 210 212 211 213 <div class="comments"> 212 set this keyword to extract a fields from the 213 structure. -1 is return is fields or structure. are 214 incorrect. 214 set this keyword to extract a field from the structure. 215 -1 is return if field or structure are incorrect. 215 216 </div> 216 217 … … 218 219 219 220 <h3>Examples</h3><div class="preformat"> 220 test = { a:1, b:2, c:3 } 221 required = ['a','c'] 222 if CHKSTRU(test,required) then print,'found a and c.' 223 IDL> print, CHKSTRU(test,'b') 221 222 IDL> test = { a:1, b:2, c:3 } 223 IDL> required = ['a','c'] 224 IDL> if CHKSTRU(test,required) then print,'found a and c.' 225 IDL> print, CHKSTRU(test,'b') 224 226 1 225 227 IDL> print, CHKSTRU(test,'b',/extract) 226 228 2 227 229 </div> … … 229 231 230 232 <h4>Version</h4><div class="preformat"> 231 $Id: chkstru.pro 3 27 2007-12-13 16:22:35Z pinsard $233 $Id: chkstru.pro 375 2008-08-08 15:55:40Z pinsard $ 232 234 233 235 Copyright (C) 1998, Martin Schultz, Harvard University … … 242 244 </div> 243 245 <h4>History</h4><div class="preformat"> 244 245 246 246 - mgs, 02 Mar 1998: VERSION 1.00 247 - mgs, 07 Apr 1998: - second parameter (FIELDS) now optional 248 - 12 Jan 2001: EXTRACT keyword by S. Masson (smasson@lodyc.jussieu.fr) 247 249 </div> 248 250
Note: See TracChangeset
for help on using the changeset viewer.