source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/isnumber.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 4.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>isnumber.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="getwrd.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="lenstr.html"><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>isnumber.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Determine if a text string is a valid number.
65
66
67   
68
69     
70      <a name="#_isnumber"></a>
71
72      <h2>isnumber  <font size="-1" color="#006633">
73</font></h2>
74
75      <p><font face="Courier"><i>result = </i>isnumber(<i><a href="#_isnumber_keyword_txt0">txt0</a>, <a href="#_isnumber_keyword_x">x</a></i>, <a href="#_isnumber_keyword_HELP">HELP</a>=<i>HELP</i>)</font></p>
76
77   
78
79
80    <h3>Return value</h3>
81       x = optionaly returned numeric value if valid. 
82       i = test flag:                                 
83           0: not a number.
84           1: txt is a long integer.
85           2: txt is a float.
86           -1: first word of txt is a long integer.
87           -2: first word of txt is a float.
88 
89
90   
91    <h3>Parameters</h3>
92   
93
94    <a name="#_isnumber_keyword_txt0"></a>
95    <h4>txt0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
96      <font size="-1" color="#006633">in</font>
97     
98     
99      <font size="-1" color="#006633">required</font>
100     
101     
102     
103     
104    </h4>
105
106   
107 text string to test.
108
109   
110
111    <a name="#_isnumber_keyword_x"></a>
112    <h4>x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113      <font size="-1" color="#006633">in</font>
114     
115     
116      <font size="-1" color="#006633">required</font>
117     
118     
119     
120     
121    </h4>
122
123   
124
125   
126   
127
128   
129    <h3>Keywords</h3>
130
131   
132    <a name="#_isnumber_keyword_HELP"></a>
133    <h4>HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134     
135     
136     
137     
138     
139     
140     
141     
142    </h4>
143
144   
145
146   
147   
148
149   
150    </pre><h3>Version history</h3>
151   
152    <h4>Version</h4>
153 $Id: isnumber.pro 372 2008-08-08 12:31:53Z pinsard $
154
155    <h4>History</h4>
156  - R. Sterner.  15 Oct, 1986. Johns Hopkins Applied Physics Lab.
157  - R. Sterner, 12 Mar, 1990 --- upgraded.
158  - Richard Garrett, 14 June, 1992 --- fixed bug in returned float value.
159  - R. Sterner, 1999 Nov 30 --- Fixed a bug found by Kristian Kjaer, Denmark
160
161 Copyright (C) 1986, Johns Hopkins University/Applied Physics Laboratory
162 This software may be used, copied, or redistributed as long as it is not
163 sold and this copyright notice is reproduced on each copy made.  This
164 routine is provided as is without any express or implied warranties
165 whatsoever.  Other limitations apply as described in the file disclaimer.txt.
166
167   
168
169   
170   
171   
172   
173   
174
175   
176   
177   
178   
179   
180   
181   
182
183    <font size="-3"><p>&nbsp;</p></font>
184    <hr size="1" color="#CCCCCC"/>
185     
186
187   
188
189    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
190
191  </body>
192</html>
Note: See TracBrowser for help on using the repository browser.