source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/chkeywd.html @ 249

Last change on this file since 249 was 249, checked in by smasson, 17 years ago

update documentation
File size: 7.4 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>chkeywd.pro (SAXO 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="chkeywd.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO 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" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/STRING//chkeywd.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" 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&lt;&lt; prev file | <a href="delchr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="chkeywd.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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/STRING/</a></h1>
82      <h2 class="pro_file">chkeywd.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 In a string containing an order to execute with EXECUTE by example.
91 We change the value of one of keywords.
92 More generally, in a string, we look for the character chain: ', keywdname= ...,
93 and we change the value of...
94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_chkeywd">
108
109          <h2><a class="top" href="#container">top</a>chkeywd <span class="categories">
110 String, keywords
111</span></h2>
112       
113          <p class="header">
114            <span class="result">result = </span>chkeywd(<span class="result"><a href="#_chkeywd_param_stringin">stringin</a>, <a href="#_chkeywd_param_keywdname">keywdname</a>, <a href="#_chkeywd_param_keywdvalue">keywdvalue</a></span>, <a href="#_chkeywd_keyword_SEPARATOR">SEPARATOR</a>=<span class="result">SEPARATOR</span>, <a href="#_chkeywd_keyword_AFTER">AFTER</a>=<span class="result">AFTER</span>)</p>
115       
116          <div class="comments">
117</div>
118
119          <h3>Return value</h3><div class="preformat">
120 stringout=stringin modified if keywdname has been found in stringin
121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_chkeywd_param_stringin">stringin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133              <span class="attr">type:</span> <span class="value">string</span>
134             
135             
136            </h4>
137       
138          <div class="comments">
139 it is a string
140</div>
141           
142            <h4 id="_chkeywd_param_keywdname">keywdname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143              <span class="attr">in</span>
144             
145             
146              <span class="attr">required</span>
147             
148              <span class="attr">type:</span> <span class="value">string</span>
149             
150             
151            </h4>
152       
153          <div class="comments">
154 it is a string designating the name of keyword to look for.
155</div>
156           
157            <h4 id="_chkeywd_param_keywdvalue">keywdvalue&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158              <span class="attr">in</span>
159             
160             
161              <span class="attr">required</span>
162             
163             
164             
165             
166            </h4>
167       
168          <div class="comments">
169 The new value of the keyword to considerate in STRINGIN
170</div>
171           
172
173         
174
175         
176
177            <h3>Keywords</h3>
178           
179            <h4 id="_chkeywd_keyword_SEPARATOR">SEPARATOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180             
181             
182             
183             
184             
185             
186             
187             
188            </h4>
189       
190            <div class="comments">
191 To look for the keyword, we look for the first sign = which follow
192 the position of keywdname. By default, we substitute the string
193 before the comma. With the keyword SEPARATOR,we can modify the cut
194 of the string. SEPARATOR give a Character before the one we have to
195 look for the comma which delimit the keyword in the string.
196 (see examples)
197</div>
198           
199            <h4 id="_chkeywd_keyword_AFTER">AFTER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200             
201             
202             
203             
204             
205             
206             
207             
208            </h4>
209       
210            <div class="comments">
211 To look for the keyword, we look for the first sign = which follow
212 the position of keywdname. By default, we substitute the string
213 before the comma. With the keyword AFTER,we can modify the cut
214 of the string. AFTER give a Character after the one we have to
215 look for the comma which delimit the keyword in the string.
216 (see examples)
217</div>
218           
219         
220
221          <h3>Examples</h3><div class="preformat">
222
223   IDL> b='ok=111, year=[1997,1998,1999], age_capitaine=35'
224   IDL> print, b
225   ok=111, year=[1997,1998,1999], age_capitaine=35
226   IDL> print, chkeywd(b,'ok','c''est bon')
227   ok='c''est bon', year=[1997,1998,1999], age_capitaine=35
228   IDL> print, chkeywd(b,'YEAR',indgen(5),sep='=')
229   ok=111, year=[0,1,2,3,4], age_capitaine=35
230   IDL> print, chkeywd(b,'YEAR',indgen(5),sep=']',/after)
231   ok=111, year=[0,1,2,3,4], age_capitaine=35
232   IDL> b='ok=111, /year, /age_capitaine'
233   IDL> print, chkeywd(b,'year','c''est bon')
234   ok=111, year='c''est bon', /age_capitaine
235</div>
236          <h3>Version history</h3>
237         
238          <h4>Version</h4><div class="preformat">
239 $Id: chkeywd.pro 238 2007-03-27 13:43:18Z pinsard $
240</div>
241          <h4>History</h4><div class="preformat">
242 Sebastien Masson (smasson@lodyc.jussieu.fr)
243                      18/10/1999
244                      24/11/1999: adaptation for keywords starting by /
245</div>
246         
247         
248          <h3>Known issues</h3>
249         
250         
251         
252          <h4>Restrictions</h4><div class="preformat">
253 If keywdvalue is an array, it will be convert in a vector.
254
255
256 Beware, this function has loops, ifs ad cases everywhere. So it can
257 not be used by big keywords (with a lot of elements which are big
258 arrays). The input keyword must not contain Complex floatings, structure,
259 Double-precision complex, Pointer, Object reference, Unsigned Integer,
260 Unsigned Longword Integer, 64-bit Integer or Unsigned 64-bit Integer.
261
262</div>
263       
264          <h3>Other attributes</h3>
265         
266         
267          <h4>Uses routines</h4><div class="preformat">
268 common.pro
269</div>
270         
271         
272         
273       
274          <h3>Statistics</h3>
275          <table class="statistics">
276            <tr><td>McCabe cyclic</td><td>           8</td></tr>
277            <tr><td>McCabe essential</td><td>           1</td></tr>
278            <tr><td>McCabe modular design</td><td>           1</td></tr>
279          </table>
280         
281       
282        </div>
283       
284      </div>
285
286     
287
288      <div id="tagline">Produced by IDLdoc 2.0.</div>
289
290    </div>
291
292  </body>
293</html>
Note: See TracBrowser for help on using the repository browser.