source: trunk/SRC/Documentation/idldoc_assistant_output/Textoidl/matchdelim.html @ 338

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

update documentation
File size: 4.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>matchdelim.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=""><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="nexttok.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Textoidl/</font></h1>
58    <h2>matchdelim.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Match open/close delimiters in a string.
65
66
67   
68
69     
70      <a name="#_matchdelim"></a>
71
72      <h2>matchdelim  <font size="-1" color="#006633">
73 Text, String
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>matchdelim(<i><a href="#_matchdelim_keyword_InString">InString</a>[, <a href="#_matchdelim_keyword_OpenPos">OpenPos</a>]</i>, <a href="#_matchdelim_keyword_OPEN_DELIM">OPEN_DELIM</a>=<i>OPEN_DELIM</i>, <a href="#_matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM</a>=<i>CLOSE_DELIM</i>, <a href="#_matchdelim_keyword_HELP">HELP</a>=<i>HELP</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_matchdelim_keyword_InString"></a>
90    <h4>InString&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91      <font size="-1" color="#006633">in</font>
92     
93     
94      <font size="-1" color="#006633">required</font>
95     
96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
97     
98     
99    </h4>
100
101    ')
102
103   
104
105    <a name="#_matchdelim_keyword_OpenPos"></a>
106    <h4>OpenPos&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
107      <font size="-1" color="#006633">in</font>
108     
109      <font size="-1" color="#006633">optional</font>
110     
111     
112     
113     
114     
115    </h4>
116
117   
118 Set to a named variable to receive the
119 position of the first opening delimiter.
120
121   
122   
123
124   
125    <h3>Keywords</h3>
126
127   
128    <a name="#_matchdelim_keyword_OPEN_DELIM"></a>
129    <h4>OPEN_DELIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130     
131     
132     
133     
134     
135     
136      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'{'</i></font>
137     
138    </h4>
139
140   
141 A single character containing the opening
142 delimiter (e.g. '(').
143
144   
145    <a name="#_matchdelim_keyword_CLOSE_DELIM"></a>
146    <h4>CLOSE_DELIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149     
150     
151     
152     
153      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'</i></font>
154     
155    </h4>
156
157    '}
158 A single character containing the closing
159 delimiter (e.g. ')').
160
161   
162    <a name="#_matchdelim_keyword_HELP"></a>
163    <h4>HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164     
165     
166     
167     
168     
169     
170     
171     
172    </h4>
173
174   
175   
176   
177
178    <h3>Examples</h3><pre>
179 matchdelim('{one{two}}three') returns 9, the character just before 'three'.
180
181    </pre><h3>Version history</h3>
182   
183    <h4>Version</h4>
184 $Id: matchdelim.pro 325 2007-12-06 10:04:53Z pinsard $
185    <h4>History</h4>
186 $Log: matchdelim.pro,v $
187 Revision 1.3  1996/06/14 20:00:27  mcraig
188 Updated Copyright info.
189
190 Revision 1.2  1996/05/09 00:22:17  mcraig
191 Removed restriction that open delim must be first char.  Added argument
192 to allow for return of position of open delim.
193
194 Revision 1.1  1996/01/31 18:41:06  mcraig
195 Initial revision;
196
197 Copyright (C) 1996 The Regents of the University of California, All
198 Rights Reserved.  Written by Matthew W. Craig.
199 See the file COPYRIGHT for restrictions on distrubting this code.
200 This code comes with absolutely NO warranty; see DISCLAIMER for details.
201
202   
203
204    <h3>Known issues</h3>
205   
206   
207   
208    <h4>Restrictions</h4>
209 Any pair of (nonidentical) characters can be used as delimiters.
210
211
212    <h3>Other attributes</h3>
213   
214   
215    <h4>Uses routines</h4>
216
217
218   
219   
220   
221
222    <font size="-3"><p>&nbsp;</p></font>
223    <hr size="1" color="#CCCCCC"/>
224     
225
226   
227
228    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
229
230  </body>
231</html>
Note: See TracBrowser for help on using the repository browser.