source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/tostr.html @ 338

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

update documentation
File size: 4.5 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>tostr.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="tostr.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//tostr.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<a href="strwhere.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="tostr.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">tostr.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Convert an input in a string.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_tostr">
105
106          <h2><a class="top" href="#container">top</a>tostr <span class="categories"> 
107 String
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>tostr(<span class="result"><a href="#_tostr_param_input">input</a></span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 a string
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_tostr_param_input">input&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments">
136 input can not contain or be of the type of:
137
138   Complex floating, structure, Double-precision complex, Pointer, Object
139   reference, Unsigned Integer, Unsigned Longword Integer, 64-bit
140   Integer, Unsigned 64-bit Integer     
141</div>
142           
143
144         
145
146         
147
148          <h3>Examples</h3><div class="preformat">
149    IDL> help, tostr(1),tostr('a'),tostr(indgen(4)),tostr(['a','jkfjo'])
150    <Expression>    STRING    = '1'
151    <Expression>    STRING    = ''a''
152    <Expression>    STRING    = '[0,1,2,3]'
153    <Expression>    STRING    = '['a','jkfjo']'
154    IDL> print, tostr(['c''est bon','c''est bon'])
155    ['c''est bon','c''est bon']
156</div>
157          <h3>Version history</h3>
158         
159          <h4>Version</h4><div class="preformat">
160 $Id: tostr.pro 325 2007-12-06 10:04:53Z pinsard $
161</div>
162          <h4>History</h4><div class="preformat">
163 Sebastien Masson (smasson@lodyc.jussieu.fr)
164                      18/10/1999
165</div>
166         
167         
168          <h3>Known issues</h3>
169         
170         
171         
172          <h4>Restrictions</h4><div class="preformat">
173 If keywdvalue is an array, it will be convert in a vector.
174
175
176 Beware, this function has loops, ifs ad cases everywhere. So it can
177 not be used by big keywords (with a lot of elements which are big
178 arrays).
179 </div>
180       
181         
182         
183         
184         
185         
186         
187         
188       
189          <h3>Statistics</h3>
190          <table class="statistics">
191            <tr><td>McCabe cyclic</td><td>           9</td></tr>
192            <tr><td>McCabe essential</td><td>           1</td></tr>
193            <tr><td>McCabe modular design</td><td>           1</td></tr>
194          </table>
195         
196       
197        </div>
198       
199      </div>
200
201     
202
203      <div id="tagline">Produced by IDLdoc 2.0.</div>
204
205    </div>
206
207  </body>
208</html>
Note: See TracBrowser for help on using the repository browser.