source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/struct2string.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.0 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>struct2string.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="struct2string.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="mixstru.html">&lt;&lt;prev file</a> | <a href="where_tag.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="struct2string.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">struct2string.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="_struct2string">
103
104          <h2><a class="top" href="#container">top</a>struct2string </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>struct2string(<span class="result"><a href="#_struct2string_param_struct">struct</a></span>, <a href="#_struct2string_keyword_CUT_IN_STRING">CUT_IN_STRING</a>=<span class="result">CUT_IN_STRING</span>, <a href="#_struct2string_keyword_MAX_STRUCT_LENGTH">MAX_STRUCT_LENGTH</a>=<span class="result">MAX_STRUCT_LENGTH</span>, <a href="#_struct2string_keyword_DIRECT2STRING">DIRECT2STRING</a>=<span class="result">DIRECT2STRING</span>)</p>
108       
109          <div class="comments">
110 NAME:struct2string
111
112 PURPOSE:convert a structure to an "executable string"
113
114 CATEGORY:bidouille
115
116 CALLING SEQUENCE:sting=struct2string(struct)
117 
118 INPUTS:struct: a structure
119
120 KEYWORD PARAMETERS:
121
122      MAX_STRUCT_LENGTH : the maximum length of the structure
123      permetted to convert the structure to string. Default is
124      10000l.
125
126      /DIRECT2STRING: to get a string instead an "executable string"
127
128      /CUT_IN_STRING: try it
129
130 OUTPUTS:
131
132 SIDE EFFECTS:use tostr.pro, cf this function header!
133
134 RESTRICTIONS:use tostr.pro, cf this function header!
135
136 EXAMPLE:
137
138      IDL> print, struct2string(!d)
139      create_struct('NAME','X','X_SIZE',891,'Y_SIZE',630,'X_VSIZE'
140      ,891,'Y_VSIZE',630,'X_CH_SIZE',6,'Y_CH_SIZE',10,'X_PX_CM'
141      ,40.0000,'Y_PX_CM',40.0000,'N_COLORS',16777216,'TABLE_SIZE'
142      ,256,'FILL_DIST',1,'WINDOW',32,'UNIT',0,'FLAGS',328124,'ORIGIN'
143      ,[0,0],'ZOOM',[1,1])
144</div>
145
146         
147
148         
149            <h3>Parameters</h3>
150       
151           
152            <h4 id="_struct2string_param_struct">struct&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153             
154             
155             
156             
157             
158             
159             
160             
161            </h4>
162       
163          <div class="comments"></div>
164           
165
166         
167
168         
169
170            <h3>Keywords</h3>
171           
172            <h4 id="_struct2string_keyword_CUT_IN_STRING">CUT_IN_STRING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173             
174             
175             
176             
177             
178             
179             
180             
181            </h4>
182       
183            <div class="comments"></div>
184           
185            <h4 id="_struct2string_keyword_MAX_STRUCT_LENGTH">MAX_STRUCT_LENGTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186             
187             
188             
189             
190             
191             
192             
193             
194            </h4>
195       
196            <div class="comments"></div>
197           
198            <h4 id="_struct2string_keyword_DIRECT2STRING">DIRECT2STRING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199             
200             
201             
202             
203             
204             
205             
206             
207            </h4>
208       
209            <div class="comments"></div>
210           
211         
212
213         
214         
215         
216         
217         
218         
219         
220         
221         
222         
223         
224         
225       
226         
227         
228         
229         
230         
231         
232         
233       
234         
235       
236        </div>
237       
238      </div>
239
240     
241
242      <div id="tagline">Produced by IDLdoc 2.0.</div>
243
244    </div>
245
246  </body>
247</html>
Note: See TracBrowser for help on using the repository browser.