Ignore:
Timestamp:
07/23/09 11:18:49 (15 years ago)
Author:
smasson
Message:

update documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strkeywd.html

    r338 r402  
    110110 
    111111    <h3>Examples</h3><pre> 
    112  We create a structure 
    113        IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35) 
    114        IDL> help, b,/struct 
     112 
     113 We create a structure: 
     114   IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35) 
     115   IDL> help, b,/struct 
    115116       ** Structure <817f4bc>, 3 tags, length=10, refs=1: 
    116117          AGE_CAPITAINE   INT             35 
    117118          OK              INT            111 
    118119          YEAR            INT       Array[3] 
    119  We put this structure as a string 
    120        IDL> a=strkeywd(b) 
    121        IDL> print, a 
     120 
     121 We put this structure as a string: 
     122   IDL> a=strkeywd(b) 
     123   IDL> print, a 
    122124       AGE_CAPITAINE=35, OK=111, YEAR=[1997,1998,1999] 
     125 
    123126 Now we can use the string a to pass keywords in a function thanks to execute!! 
    124        IDL> test=execute('c=get_extra('+a+')') 
    125        IDL> help, c,/struct 
     127   IDL> test=execute('c=get_extra('+a+')') 
     128   IDL> help, c,/struct 
    126129       ** Structure <817f2dc>, 3 tags, length=10, refs=1: 
    127130          AGE_CAPITAINE   INT             35 
     
    132135     
    133136    <h4>Version</h4> 
    134  $Id: strkeywd.pro 325 2007-12-06 10:04:53Z pinsard $ 
     137 $Id: strkeywd.pro 372 2008-08-08 12:31:53Z pinsard $ 
    135138 
    136139    <h4>History</h4> 
     
    145148     
    146149    <h4>Restrictions</h4> 
    147  If an element of the structure contain an array, it will be convert in a vector. 
     150 If an element of the structure contain an array, it will be convert in a  
     151 vector. 
    148152 
    149153 
    150  Beware, this function has loops, ifs ad cases everywhere. So it can  
     154 Beware, this function has loops, ifs and cases everywhere. So it can  
    151155 not be used by big keywords (with a lot of elements which are big  
    152156 arrays). The input keyword must not contain Complex floatings, structure,  
Note: See TracChangeset for help on using the changeset viewer.