source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRUCTURE/mixstru.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 4.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>mixstru.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="extractstru.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="struct2string.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRUCTURE/</font></h1>
58    <h2>mixstru.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Concatenate 2 structures together. The difference with CREATE_STRUCT
65 is  that if the 2 structure have same elements's name, then mixstru
66 do not break down but choose for the common element the value
67 specified by the first structure.
68
69
70   
71
72     
73      <a name="#_mixstru"></a>
74
75      <h2>mixstru  <font size="-1" color="#006633">
76 Structure
77 </font></h2>
78
79      <p><font face="Courier"><i>result = </i>mixstru(<i><a href="#_mixstru_keyword_stru1">stru1</a>, <a href="#_mixstru_keyword_stru2">stru2</a></i>)</font></p>
80
81   
82
83
84    <h3>Return value</h3>
85 A structure
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_mixstru_keyword_stru1"></a>
93    <h4>stru1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99     
100     
101     
102    </h4>
103
104   
105 Structure which can have same elements's name than
106 STRU2 but with a different value.
107
108   
109
110    <a name="#_mixstru_keyword_stru2"></a>
111    <h4>stru2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112      <font size="-1" color="#006633">in</font>
113     
114     
115      <font size="-1" color="#006633">required</font>
116     
117     
118     
119     
120    </h4>
121
122   
123 Structure which can have same elements's name than
124 STRU1 but with a different value.
125
126   
127   
128
129   
130
131    <h3>Examples</h3><pre>
132     
133     IDL> a=get_extra(/toto,ok=123)
134     IDL> b=get_extra(ok=111, year=1999, age_capitaine=35)
135     IDL> help, a,b,/struct
136     ** Structure <8334424>, 2 tags, length=4, refs=1:
137        OK              INT            123
138        TOTO            INT              1
139     ** Structure <8373da4>, 3 tags, length=6, refs=1:
140        AGE_CAPITAINE   INT             35
141        OK              INT            111
142        YEAR            INT           1999
143     IDL> help, mixstru(a,b),/struct
144     ** Structure <82f25ac>, 4 tags, length=8, refs=1:
145        AGE_CAPITAINE   INT             35
146        YEAR            INT           1999
147        OK              INT            123
148        TOTO            INT              1
149     IDL> help, mixstru(b,a),/struct
150     ** Structure <834604c>, 4 tags, length=8, refs=1:
151        TOTO            INT              1
152        AGE_CAPITAINE   INT             35
153        OK              INT            111
154        YEAR            INT           1999
155
156    </pre><h3>Version history</h3>
157   
158    <h4>Version</h4>
159 $Id: mixstru.pro 325 2007-12-06 10:04:53Z pinsard $
160
161    <h4>History</h4>
162 Sebastien Masson (smasson@lodyc.jussieu.fr)
163                      7/10/1999
164
165   
166
167    <h3>Known issues</h3>
168   
169   
170   
171    <h4>Restrictions</h4>
172 If STRU1 or  STRU2 is not a structure, mixstru send back -1
173
174
175   
176   
177   
178   
179   
180   
181   
182
183    <font size="-3"><p>&nbsp;</p></font>
184    <hr size="1" color="#CCCCCC"/>
185     
186
187   
188
189    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
190
191  </body>
192</html>
Note: See TracBrowser for help on using the repository browser.