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

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

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 4.1 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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<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?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">tostr.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="_tostr">
103
104          <h2><a class="top" href="#container">top</a>tostr </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>tostr(<span class="result"><a href="#_tostr_param_input">input</a></span>)</p>
108       
109          <div class="comments">
110 NAME: tostr (to string)
111
112 PURPOSE: convertit un input en un string.
113
114 CATEGORY:
115
116 CALLING SEQUENCE: res=tostr(input)
117 
118 INPUTS: input ne peut pas contenir ou etre de type:
119
120   Complex floating, structure, Double-precision complex, Pointer, Object
121   reference, Unsigned Integer, Unsigned Longword Integer, 64-bit
122   Integer, Unsigned 64-bit Integer     
123
124 KEYWORD PARAMETERS: none
125
126 OUTPUTS: un string
127
128 COMMON BLOCKS:
129
130 SIDE EFFECTS:
131
132   Si un element de input contient un tableau, il sera
133   convertit en vecteur.
134
135 RESTRICTIONS:
136
137   attention cette fonction comporte des boucles, des if et des cases
138   ds tous les sens. Elle ne doit donc pas etre utilisee avec des
139   inputs de grosse taille (avec bcp d''elements et avec des
140   elements etant de gros tableaux).
141 EXAMPLE:
142    IDL> help, tostr(1),tostr('a'),tostr(indgen(4)),tostr(['a','jkfjo'])
143    <Expression>    STRING    = '1'
144    <Expression>    STRING    = ''a''
145    <Expression>    STRING    = '[0,1,2,3]'
146    <Expression>    STRING    = '['a','jkfjo']'
147    IDL> print, tostr(['c''est bon','c''est bon'])
148    ['c''est bon','c''est bon']
149</div>
150
151         
152
153         
154            <h3>Parameters</h3>
155       
156           
157            <h4 id="_tostr_param_input">input&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158             
159             
160             
161             
162             
163             
164             
165             
166            </h4>
167       
168          <div class="comments"></div>
169           
170
171         
172
173         
174
175         
176         
177         
178         
179         
180         
181         
182         
183         
184         
185         
186         
187       
188         
189         
190         
191         
192         
193         
194         
195       
196         
197       
198        </div>
199       
200      </div>
201
202     
203
204      <div id="tagline">Produced by IDLdoc 2.0.</div>
205
206    </div>
207
208  </body>
209</html>
Note: See TracBrowser for help on using the repository browser.