source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strkeywd.html @ 177

Last change on this file since 177 was 177, checked in by smasson, 18 years ago

updates of html files...
File size: 4.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>strkeywd.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="string2struct.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="strrepl.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRING/</font></h1>
58    <h2>strkeywd.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Translate a structure in a string able to be used to specify keywords
65 in the calling of a function when we use EXECUTE (see example)
66
67
68   
69
70     
71      <a name="#_strkeywd"></a>
72
73      <h2>strkeywd  <font size="-1" color="#006633"> 
74 </font></h2>
75
76      <p><font face="Courier"><i>result = </i>strkeywd(<i><a href="#_strkeywd_keyword_struct">struct</a></i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 a string composed like following:
83 For each element of the structure, we write a part of the string as:
84         'name_of_the_element=content_of_the_element'
85
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_strkeywd_keyword_struct"></a>
92    <h4>struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93     
94     
95     
96     
97     
98     
99     
100     
101    </h4>
102
103   
104 a structure
105
106   
107   
108
109   
110
111    <h3>Examples</h3>
112 We create a structure
113       IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35)
114       IDL> help, b,/struct
115       ** Structure <817f4bc>, 3 tags, length=10, refs=1:
116          AGE_CAPITAINE   INT             35
117          OK              INT            111
118          YEAR            INT       Array[3]
119 We put this structure as a string
120       IDL> a=strkeywd(b)
121       IDL> print, a
122       AGE_CAPITAINE=35, OK=111, YEAR=[1997,1998,1999]
123 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
126       ** Structure <817f2dc>, 3 tags, length=10, refs=1:
127          AGE_CAPITAINE   INT             35
128          OK              INT            111
129          YEAR            INT       Array[3]
130
131    <h3>Version history</h3>
132   
133    <h4>Version</h4>
134 $Id: strkeywd.pro 163 2006-08-29 12:59:46Z navarro $
135
136    <h4>History</h4>
137 Sebastien Masson (smasson@lodyc.jussieu.fr)
138                      11/10/1999
139
140   
141
142    <h3>Known issues</h3>
143   
144   
145   
146    <h4>Restrictions</h4>
147 If an element of the structure contain an array, it will be convert in a vector.
148
149
150 Beware, this function has loops, ifs ad cases everywhere. So it can
151 not be used by big keywords (with a lot of elements which are big
152 arrays). The input keyword must not contain Complex floatings, structure,
153 Double-precision complex, Pointer, Object reference, Unsigned Integer,
154 Unsigned Longword Integer, 64-bit Integer or Unsigned 64-bit Integer.
155
156
157   
158   
159   
160   
161   
162   
163   
164
165    <font size="-3"><p>&nbsp;</p></font>
166    <hr size="1" color="#CCCCCC"/>
167     
168
169   
170
171    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Wed Sep 13 16:32:58 2006.</font></p>
172
173  </body>
174</html>
Note: See TracBrowser for help on using the repository browser.