Changeset 402 for trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRUCTURE/chkstru.html

Timestamp:

07/23/09 11:18:49 (15 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRUCTURE/chkstru.html (modified) (8 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRUCTURE/chkstru.html

@@ -80 +80 @@
 
     <h3>Return value</h3>
- CHKSTRU returns 1 if successful, otherwise 0.
+ 1 if successful, otherwise 0.
 
 
@@ -119 +119 @@
     
  A string or string array with field names to 
- be contained in STRUCTURE. CHKSTRU returns 1 (true)
- only if all field names are contained in STRUCTURE.
+ be contained in STRUCTURE.
+
+ CHKSTRU returns 1 (true) only if all field names are contained in STRUCTURE.
+
  The entries of FIELDS may be upper or lowercase.
 
@@ -144 +146 @@
     
  A named variable that will contain the indices of
- the required field names in the structure. They can then
- be assessed through structure.(index[i]) . Index will
- contain -1 for all fields entries that are not in the
- structure.
+ the required field names in the structure. 
+
+ They can then be assessed through structure.(index[i]). 
+
+ Index will contain -1 for all fields entries that are not in the structure.
 
     
@@ -163 +166 @@
 
     
- set this keyword to return an error message 
- in case of an error.
+ set this keyword to return an error message in case of an error.
 
     
@@ -180 +182 @@
 
     
- set this keyword to extract a fields from the
- structure.  -1 is return is fields or structure. are
- incorrect.
+ set this keyword to extract a field from the structure.  
+ -1 is return if field or structure are incorrect.
 
     
@@ -188 +189 @@
 
     <h3>Examples</h3><pre>
-        test = { a:1, b:2, c:3 }
-        required = ['a','c']
-        if CHKSTRU(test,required) then print,'found a and c.'
-        IDL> print, CHKSTRU(test,'b')
+
+   IDL> test = { a:1, b:2, c:3 }
+   IDL> required = ['a','c']
+   IDL> if CHKSTRU(test,required) then print,'found a and c.'
+   IDL> print, CHKSTRU(test,'b')
            1
-        IDL> print, CHKSTRU(test,'b',/extract)
+   IDL> print, CHKSTRU(test,'b',/extract)
                2
 
@@ -199 +201 @@
     
     <h4>Version</h4>
- $Id: chkstru.pro 327 2007-12-13 16:22:35Z pinsard $
+ $Id: chkstru.pro 375 2008-08-08 15:55:40Z pinsard $
 
  Copyright (C) 1998, Martin Schultz, Harvard University
@@ -212 +214 @@
 
     <h4>History</h4>
-        mgs, 02 Mar 1998: VERSION 1.00
-        mgs, 07 Apr 1998: - second parameter (FIELDS) now optional
-        12 Jan 2001: EXTRACT keyword by S. Masson (smasson@lodyc.jussieu.fr) 
+  - mgs, 02 Mar 1998: VERSION 1.00
+  - mgs, 07 Apr 1998: - second parameter (FIELDS) now optional
+  - 12 Jan 2001: EXTRACT keyword by S. Masson (smasson@lodyc.jussieu.fr)