source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strkeywd.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.1 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>strkeywd.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="strkeywd.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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="string2struct.html">&lt;&lt;prev file</a> | <a href="strrepl.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strkeywd.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;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/STRING/</a></h1>
82      <h2 class="pro_file">strkeywd.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="_strkeywd">
103
104          <h2><a class="top" href="#container">top</a>strkeywd </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>strkeywd(<span class="result"><a href="#_strkeywd_param_struct">struct</a></span>)</p>
108       
109          <div class="comments">
110 NAME: strkeywd (string keywords)
111
112 PURPOSE: traduit une sturcture en un string pouvant etre utilise
113 pour specifier des keywords ds l''appelle d''une fonction qd on
114 utilise execute (cf l''exemple)
115
116 CATEGORY: pour passer des mots cles avec execute !
117
118 CALLING SEQUENCE:res=strkeywd(struct)
119 
120 INPUTS:struct: une structure
121
122 KEYWORD PARAMETERS:
123
124 OUTPUTS:un string compose de la facon suivante:
125         pour chaque element de la structure, on ecrit une partie du
126         string sous la forme:
127         'nom_de_l''element=contennu de l''element'
128
129 COMMON BLOCKS:
130
131 SIDE EFFECTS:
132
133   Si un element de la structure contient un tableau, il sera
134   convertit en vecteur.
135
136 RESTRICTIONS:
137
138   attention cette fonction comporte des boucles, des if et des cases
139   ds tous les sens. Elle ne doit donc pas etre utilisee avec des
140   structure de grosse taille (avec bcp d''elements et avec des
141   elements etant de gros tableaux).
142   la structure en entree ne doit pas contenir de Complex floating, de
143   structure, de Double-precision complex, de Pointer, de Object
144   reference, de Unsigned Integer, de Unsigned Longword Integer, de
145   64-bit Integer, de Unsigned 64-bit Integer   
146
147
148
149 EXAMPLE:
150
151 on cree une structure
152       IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35)
153       IDL> help, b,/struct
154       ** Structure <817f4bc>, 3 tags, length=10, refs=1:
155          AGE_CAPITAINE   INT             35
156          OK              INT            111
157          YEAR            INT       Array[3]
158 on met cette structure sous forme de string
159       IDL> a=strkeywd(b)
160       IDL> print, a
161       AGE_CAPITAINE=35, OK=111, YEAR=[1997,1998,1999]
162 maintenant on peut utiliser le string a pour passer des mots cles ds
163 une fonction a l''aide de execute!!
164       IDL> test=execute('c=get_extra('+a+')')
165       IDL> help, c,/struct
166       ** Structure <817f2dc>, 3 tags, length=10, refs=1:
167          AGE_CAPITAINE   INT             35
168          OK              INT            111
169          YEAR            INT       Array[3]
170</div>
171
172         
173
174         
175            <h3>Parameters</h3>
176       
177           
178            <h4 id="_strkeywd_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189          <div class="comments"></div>
190           
191
192         
193
194         
195
196         
197         
198         
199         
200         
201         
202         
203         
204         
205         
206         
207         
208       
209         
210         
211         
212         
213         
214         
215         
216       
217         
218       
219        </div>
220       
221      </div>
222
223     
224
225      <div id="tagline">Produced by IDLdoc 2.0.</div>
226
227    </div>
228
229  </body>
230</html>
Note: See TracBrowser for help on using the repository browser.