source: trunk/SRC/Documentation/idldoc_assistant_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: 3.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>tostr.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="strwhere.html"><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=""><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRING/</font></h1>
58    <h2>tostr.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Convert an input in a string.
65
66
67   
68
69     
70      <a name="#_tostr"></a>
71
72      <h2>tostr  <font size="-1" color="#006633"> 
73 String
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>tostr(<i><a href="#_tostr_keyword_input">input</a></i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 a string
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_tostr_keyword_input"></a>
90    <h4>input&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     
97     
98     
99    </h4>
100
101   
102 input can not contain or be of the type of:
103
104   Complex floating, structure, Double-precision complex, Pointer, Object
105   reference, Unsigned Integer, Unsigned Longword Integer, 64-bit
106   Integer, Unsigned 64-bit Integer     
107
108   
109   
110
111   
112
113    <h3>Examples</h3><pre>
114    IDL> help, tostr(1),tostr('a'),tostr(indgen(4)),tostr(['a','jkfjo'])
115    <Expression>    STRING    = '1'
116    <Expression>    STRING    = ''a''
117    <Expression>    STRING    = '[0,1,2,3]'
118    <Expression>    STRING    = '['a','jkfjo']'
119    IDL> print, tostr(['c''est bon','c''est bon'])
120    ['c''est bon','c''est bon']
121
122    </pre><h3>Version history</h3>
123   
124    <h4>Version</h4>
125 $Id: tostr.pro 325 2007-12-06 10:04:53Z pinsard $
126
127    <h4>History</h4>
128 Sebastien Masson (smasson@lodyc.jussieu.fr)
129                      18/10/1999
130
131   
132
133    <h3>Known issues</h3>
134   
135   
136   
137    <h4>Restrictions</h4>
138 If keywdvalue is an array, it will be convert in a vector.
139
140
141 Beware, this function has loops, ifs ad cases everywhere. So it can
142 not be used by big keywords (with a lot of elements which are big
143 arrays).
144 
145
146   
147   
148   
149   
150   
151   
152   
153
154    <font size="-3"><p>&nbsp;</p></font>
155    <hr size="1" color="#CCCCCC"/>
156     
157
158   
159
160    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
161
162  </body>
163</html>
Note: See TracBrowser for help on using the repository browser.