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

Last change on this file since 104 was 104, checked in by pinsard, 18 years ago

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation
File size: 6.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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_chkeywd">
103
104          <h2><a class="top" href="#container">top</a>chkeywd </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME: chkeywd (change keyword)
111
112 PURPOSE: ds un string qui contient une commande a executer avec
113 EXECUTE par ex. On change la valeur d''un des mot cle.
114 Plus generalement, ds un string, on cherche la chaine de
115 chacarteres: ', keywdname= ..., et on change la valeur de ...
116
117 CATEGORY: pour bidouiller des commandes passees par execute
118
119 CALLING SEQUENCE: stringout=chkeywd(stringin, keywdname, keywdvalue)
120 
121 INPUTS:
122      stringin: un string
123      keywdname: un string designant le nom du mot clef a chercher.
124      keywdvalue: nouvelle valeur du mot clef a considerer ds stringin
125
126 KEYWORD PARAMETERS:
127      pour chercher le mot cle, on cherche le premier signe = qui
128      suit la position de keywdname. on substitue
129      pardefaut tout le bout de string qui suit jusqu''a la prochaine
130      virgule. avec les mots cles SEPARATOR et AFTER on peut modifier
131      cette decoupe du string:
132      SEPARATOR donne un chatactere avant (ou apres si AFTER est
133      active) lequel il faut chercher la virgule qui delimite le mot
134      cle ds le string. cf. les exemples
135
136 OUTPUTS:stringout=stringin modifie si keywdname a ete trouve ds
137 stringin
138
139 COMMON BLOCKS:common.pro
140
141 SIDE EFFECTS:
142   
143   Si keywdvalue est un tableau, il sera convertit en vecteur.
144
145 RESTRICTIONS:
146
147   attention cette fonction comporte des boucles, des if et des cases
148   ds tous les sens. Elle ne doit donc pas etre utilisee avec des
149   mots clefs de grosse taille (avec bcp d''elements et avec des
150   elements etant de gros tableaux).
151   le mot clef en entree ne doit pas contenir de Complex floating, de
152   structure, de Double-precision complex, de Pointer, de Object
153   reference, de Unsigned Integer, de Unsigned Longword Integer, de
154   64-bit Integer, de Unsigned 64-bit Integer   
155
156 EXAMPLE:
157
158   IDL> b='ok=111, year=[1997,1998,1999], age_capitaine=35'
159   IDL> print, b
160   ok=111, year=[1997,1998,1999], age_capitaine=35
161   IDL> print, chkeywd(b,'ok','c''est bon')
162   ok='c''est bon', year=[1997,1998,1999], age_capitaine=35
163   IDL> print, chkeywd(b,'YEAR',indgen(5),sep='=')
164   ok=111, year=[0,1,2,3,4], age_capitaine=35
165   IDL> print, chkeywd(b,'YEAR',indgen(5),sep=']',/after)
166   ok=111, year=[0,1,2,3,4], age_capitaine=35
167   IDL> b='ok=111, /year, /age_capitaine'
168   IDL> print, chkeywd(b,'year','c''est bon')
169   ok=111, year='c''est bon', /age_capitaine
170</div>
171
172         
173
174         
175            <h3>Parameters</h3>
176       
177           
178            <h4 id="_chkeywd_param_stringin">stringin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189          <div class="comments"></div>
190           
191            <h4 id="_chkeywd_param_keywdname">keywdname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193             
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202          <div class="comments"></div>
203           
204            <h4 id="_chkeywd_param_keywdvalue">keywdvalue&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205             
206             
207             
208             
209             
210             
211             
212             
213            </h4>
214       
215          <div class="comments"></div>
216           
217
218         
219
220         
221
222            <h3>Keywords</h3>
223           
224            <h4 id="_chkeywd_keyword_SEPARATOR">SEPARATOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
225             
226             
227             
228             
229             
230             
231             
232             
233            </h4>
234       
235            <div class="comments"></div>
236           
237            <h4 id="_chkeywd_keyword_AFTER">AFTER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238             
239             
240             
241             
242             
243             
244             
245             
246            </h4>
247       
248            <div class="comments"></div>
249           
250         
251
252         
253         
254         
255         
256         
257         
258         
259         
260         
261         
262         
263         
264       
265         
266         
267         
268         
269         
270         
271         
272       
273         
274       
275        </div>
276       
277      </div>
278
279     
280
281      <div id="tagline">Produced by IDLdoc 2.0.</div>
282
283    </div>
284
285  </body>
286</html>
Note: See TracBrowser for help on using the repository browser.