source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/extractstru.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.3 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>extractstru.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="extractstru.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="chkstru.html">&lt;&lt;prev file</a> | <a href="mixstru.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="extractstru.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/STRUCTURE/</a></h1>
82      <h2 class="pro_file">extractstru.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="_extractstru">
103
104          <h2><a class="top" href="#container">top</a>extractstru </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>extractstru(<span class="result"><a href="#_extractstru_param_stru">stru</a>, <a href="#_extractstru_param_liste">liste</a></span>, <a href="#_extractstru_keyword_GARDE">GARDE</a>=<span class="result">GARDE</span>, <a href="#_extractstru_keyword_VIRE">VIRE</a>=<span class="result">VIRE</span>)</p>
108       
109          <div class="comments">
110 NAME:extractstru
111
112 PURPOSE:extrait des elements d''une structure pour constituer une
113         nouvelle structure
114
115 CATEGORY: dibouille sur les structures
116
117 CALLING SEQUENCE: res = extractstru(stru, liste)
118 
119 INPUTS:
120
121    stru: une structure
122
123    liste: un vecteur de string comportant les noms des elements de
124    stru a virer (par DEFAUT) ou a garder (si GARDE est active)
125
126 KEYWORD PARAMETERS:
127
128    /GARDE: specifie que la liste donnee concerne les elements de
129    stru a garder
130
131    /VIRE: specifie que la liste donnee concerne les elements de
132    stru a virer. Ce mot cle est active par defaut
133
134 OUTPUTS:une stucture ou -1 en cas de pb
135
136 COMMON BLOCKS:
137
138 SIDE EFFECTS:
139
140 RESTRICTIONS: none !!!
141    liste peut contenir des noms d''elements qui ne sont pas ds stru,
142    le programme se debrouille avec
143
144 EXAMPLE:
145
146    IDL> extra=get_extra(/ok, year=1999, age_capitaine=35 )
147    IDL> help, extra,/struct
148    ** Structure <83e66bc>, 3 tags, length=6, refs=1:
149       AGE_CAPITAINE   INT             35
150       OK              INT              1
151       YEAR            INT           1999
152    IDL> help, extractstru(extra,['ok','hhuihi','YEAR']),/stru
153    ** Structure <831afac>, 1 tags, length=2, refs=1:
154       AGE_CAPITAINE   INT             35
155    IDL> help, extractstru(extra,['ok','hhuihi','YEAR'],/garde),/stru
156    ** Structure <834bbc4>, 2 tags, length=4, refs=1:
157       OK              INT              1
158       YEAR            INT           1999
159</div>
160
161         
162
163         
164            <h3>Parameters</h3>
165       
166           
167            <h4 id="_extractstru_param_stru">stru&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168             
169             
170             
171             
172             
173             
174             
175             
176            </h4>
177       
178          <div class="comments"></div>
179           
180            <h4 id="_extractstru_param_liste">liste&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181             
182             
183             
184             
185             
186             
187             
188             
189            </h4>
190       
191          <div class="comments"></div>
192           
193
194         
195
196         
197
198            <h3>Keywords</h3>
199           
200            <h4 id="_extractstru_keyword_GARDE">GARDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202             
203             
204             
205             
206             
207             
208             
209            </h4>
210       
211            <div class="comments"></div>
212           
213            <h4 id="_extractstru_keyword_VIRE">VIRE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
214             
215             
216             
217             
218             
219             
220             
221             
222            </h4>
223       
224            <div class="comments"></div>
225           
226         
227
228         
229         
230         
231         
232         
233         
234         
235         
236         
237         
238         
239         
240       
241         
242         
243         
244         
245         
246         
247         
248       
249         
250       
251        </div>
252       
253      </div>
254
255     
256
257      <div id="tagline">Produced by IDLdoc 2.0.</div>
258
259    </div>
260
261  </body>
262</html>
Note: See TracBrowser for help on using the repository browser.