source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strright.html @ 402

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

update documentation
File size: 4.9 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>strright.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="strright.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//strright.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="strkeywd.html">&lt;&lt;prev file</a> | <a href="strsci.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strright.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">strright.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 return right subportion from 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="_strright">
105
106          <h2><a class="top" href="#container">top</a>strright <span class="categories">
107 String
108 </span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>strright(<span class="result"><a href="#_strright_param_s">s</a>, <a href="#_strright_param_lastn">lastn</a></span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 The portion of LASTN characters of S counted from the back.
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_strright_param_s">s&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 the string to be searched
137</div>
138           
139            <h4 id="_strright_param_lastn">lastn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140              <span class="attr">in</span>
141             
142             
143              <span class="attr">required</span>
144             
145             
146              <span class="attr">default:</span> <span class="value">1</span>
147             
148            </h4>
149       
150          <div class="comments">
151 the number of characters to be returned.
152
153 If LASTN is the strlen(STRING), the complete string
154 is returned.
155</div>
156           
157
158         
159
160         
161
162          <h3>Examples</h3><div class="preformat">
163 
164 add a "/" in to path if it "/" is not at the end :
165
166  IDL> path="/tmp"
167  IDL> if (strright(path) ne '/') then path = path + '/'
168  IDL> print,path
169  /tmp/
170</div>
171          <h3>Version history</h3>
172         
173          <h4>Version</h4><div class="preformat">
174 $Id: strright.pro 374 2008-08-08 15:12:27Z pinsard $
175
176 Copyright (C) 1997, Martin Schultz, Harvard University
177 This software is provided as is without any warranty
178 whatsoever. It may be freely used, copied or distributed
179 for non-commercial purposes. This copyright notice must be
180 kept with any copy of this software. If this software shall
181 be used commercially or sold as part of a larger package,
182 please contact the author to arrange payment.
183 Bugs and comments should be directed to mgs@io.harvard.edu
184 with subject "IDL routine strright"</div>
185          <h4>History</h4><div class="preformat">
186        mgs, 19 Nov 1997: VERSION 1.00
187</div>
188         
189         
190         
191         
192         
193         
194         
195       
196         
197         
198         
199         
200         
201         
202         
203       
204          <h3>Statistics</h3>
205          <table class="statistics">
206            <tr><td>McCabe cyclic</td><td>           4</td></tr>
207            <tr><td>McCabe essential</td><td>           1</td></tr>
208            <tr><td>McCabe modular design</td><td>           1</td></tr>
209          </table>
210         
211       
212        </div>
213       
214      </div>
215
216     
217
218      <div id="tagline">Produced by IDLdoc 2.0.</div>
219
220    </div>
221
222  </body>
223</html>
Note: See TracBrowser for help on using the repository browser.