source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/lenstr.html @ 97

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

start to modify headers of Obsolete *.pro files for better idldoc output

File size: 4.0 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>lenstr.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="lenstr.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="isnumber.html">&lt;&lt;prev file</a> | <a href="nwrds.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="lenstr.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">lenstr.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="_lenstr">
103
104          <h2><a class="top" href="#container">top</a>lenstr </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>lenstr(<span class="result"><a href="#_lenstr_param_str">str</a></span>)</p>
108       
109          <div class="comments">
110 ROUTINE:         lenstr
111 USEAGE:          result=lenstr(str)
112
113 input:
114  str             a single string or string array.
115 
116 output:
117  result          length of the string(s) in normalized units
118                  the number of elements of RESULT matches the number of
119                  elements of STRING.
120
121 procedure:
122                  This function returns the physical length of the
123                  string on the output device, not the number of
124                  characters.  This is done by first switching to 'X'
125                  and writing the string(s) with XYOUTS in graphics
126                  mode 5, which disables display to the screen but
127                  does not interfere with operation of XYOUTS.  The
128                  WIDTH keyword parameter of XYOUTS is used to
129                  retrieve the physical length of the string(s).
130
131  author:  Paul Ricchiazzi                            7apr93
132           Institute for Computational Earth System Science
133           University of California, Santa Barbara</div>
134
135         
136
137         
138            <h3>Parameters</h3>
139       
140           
141            <h4 id="_lenstr_param_str">str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142             
143             
144             
145             
146             
147             
148             
149             
150            </h4>
151       
152          <div class="comments"></div>
153           
154
155         
156
157         
158
159         
160         
161         
162         
163         
164         
165         
166         
167         
168         
169         
170         
171       
172         
173         
174         
175         
176         
177         
178         
179       
180         
181       
182        </div>
183       
184      </div>
185
186     
187
188      <div id="tagline">Produced by IDLdoc 2.0.</div>
189
190    </div>
191
192  </body>
193</html>
Note: See TracBrowser for help on using the repository browser.