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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

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