source: trunk/SRC/Documentation/idldoc_html_output/Textoidl/matchdelim.html @ 376

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

update documentation
File size: 6.2 KB
RevLine 
[89]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>
[104]9    <title>matchdelim.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="matchdelim.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Textoidl//matchdelim.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]74&lt;&lt; prev file | <a href="nexttok.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="matchdelim.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Textoidl/</a></h1>
[89]82      <h2 class="pro_file">matchdelim.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[163]89      <div id="file_comments">
90 Match open/close delimiters in a string.
91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
[163]104        <div class="routine_details" id="_matchdelim">
[89]105
[163]106          <h2><a class="top" href="#container">top</a>matchdelim <span class="categories">
107 Text, String
108</span></h2>
[89]109       
110          <p class="header">
[163]111            <span class="result">result = </span>matchdelim(<span class="result"><a href="#_matchdelim_param_InString">InString</a>[, <a href="#_matchdelim_param_OpenPos">OpenPos</a>]</span>, <a href="#_matchdelim_keyword_OPEN_DELIM">OPEN_DELIM</a>=<span class="result">OPEN_DELIM</span>, <a href="#_matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM</a>=<span class="result">CLOSE_DELIM</span>, <a href="#_matchdelim_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p>
[89]112       
[234]113          <div class="comments">
114</div>
[89]115
[163]116          <h3>Return value</h3><div class="preformat">
[89]117
[163]118</div>
[89]119
120         
121            <h3>Parameters</h3>
122       
123           
[163]124            <h4 id="_matchdelim_param_InString">InString&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
[89]126             
127             
[163]128              <span class="attr">required</span>
[89]129             
[163]130              <span class="attr">type:</span> <span class="value">string</span>
[89]131             
132             
133            </h4>
134       
[163]135          <div class="comments">')
136</div>
[89]137           
[163]138            <h4 id="_matchdelim_param_OpenPos">OpenPos&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139              <span class="attr">in</span>
[89]140             
[163]141              <span class="attr">optional</span>
[89]142             
143             
144             
145             
146             
147            </h4>
148       
[163]149          <div class="comments">
150 Set to a named variable to receive the
151 position of the first opening delimiter.
152</div>
[89]153           
154
155         
156
157         
158
159            <h3>Keywords</h3>
160           
[163]161            <h4 id="_matchdelim_keyword_OPEN_DELIM">OPEN_DELIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]162             
163             
164             
165             
166             
167             
[163]168              <span class="attr">default:</span> <span class="value">'{'</span>
[89]169             
170            </h4>
171       
[163]172            <div class="comments">
173 A single character containing the opening
174 delimiter (e.g. '(').
175</div>
[89]176           
[163]177            <h4 id="_matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]178             
179             
180             
181             
182             
183             
[163]184              <span class="attr">default:</span> <span class="value">'</span>
[89]185             
186            </h4>
187       
[163]188            <div class="comments">'}
189 A single character containing the closing
190 delimiter (e.g. ')').
191</div>
[89]192           
[163]193            <h4 id="_matchdelim_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]194             
195             
196             
197             
198             
199             
200             
201             
202            </h4>
203       
204            <div class="comments"></div>
205           
206         
207
[163]208          <h3>Examples</h3><div class="preformat">
209 matchdelim('{one{two}}three') returns 9, the character just before 'three'.
210</div>
211          <h3>Version history</h3>
[89]212         
[163]213          <h4>Version</h4><div class="preformat">
[338]214 $Id: matchdelim.pro 325 2007-12-06 10:04:53Z pinsard $</div>
[163]215          <h4>History</h4><div class="preformat">
216 $Log: matchdelim.pro,v $
217 Revision 1.3  1996/06/14 20:00:27  mcraig
218 Updated Copyright info.
219
220 Revision 1.2  1996/05/09 00:22:17  mcraig
221 Removed restriction that open delim must be first char.  Added argument
222 to allow for return of position of open delim.
223
224 Revision 1.1  1996/01/31 18:41:06  mcraig
225 Initial revision;
226
227 Copyright (C) 1996 The Regents of the University of California, All
228 Rights Reserved.  Written by Matthew W. Craig.
229 See the file COPYRIGHT for restrictions on distrubting this code.
230 This code comes with absolutely NO warranty; see DISCLAIMER for details.
231</div>
[89]232         
233         
[163]234          <h3>Known issues</h3>
[89]235         
236         
237         
[163]238          <h4>Restrictions</h4><div class="preformat">
239 Any pair of (nonidentical) characters can be used as delimiters.
240</div>
[89]241       
[163]242          <h3>Other attributes</h3>
[89]243         
244         
[163]245          <h4>Uses routines</h4><div class="preformat">
246
247</div>
[89]248         
249         
250         
251       
[163]252          <h3>Statistics</h3>
253          <table class="statistics">
254            <tr><td>McCabe cyclic</td><td>           8</td></tr>
255            <tr><td>McCabe essential</td><td>           1</td></tr>
256            <tr><td>McCabe modular design</td><td>           1</td></tr>
257          </table>
[89]258         
259       
260        </div>
261       
262      </div>
263
264     
265
266      <div id="tagline">Produced by IDLdoc 2.0.</div>
267
268    </div>
269
270  </body>
[249]271</html>
Note: See TracBrowser for help on using the repository browser.