source: trunk/SRC/Documentation/idldoc_html_output/Grid/saveboxparam.html @ 103

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

start to modify headers of Grid .pro files for better idldoc output
File size: 3.8 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>saveboxparam.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="saveboxparam.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="restoreboxparam.html">&lt;&lt;prev file</a> | <a href="smallmeshmask.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="saveboxparam.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">Grid/</a></h1>
82      <h2 class="pro_file">saveboxparam.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> save all the zoom parameters (defined by calling domdef)
90          in a file (using save command) located in myuniquetmpdir
91          (common variable defined by def_myuniquetmpdir)
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_saveboxparam">
106
107          <h2><a class="top" href="#container">top</a>saveboxparam </h2>
108       
109          <p class="header">
110            saveboxparam<span class="result">, <a href="#_saveboxparam_param_filename">filename</a></span></p>
111       
112          <div class="comments">
113</div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_saveboxparam_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124             
125              <span class="attr">required</span>
126             
127             
128             
129             
130            </h4>
131       
132          <div class="comments"> a scalar string defining the file name
133</div>
134           
135
136         
137
138         
139
140          <h3>Examples</h3><div class="value">
141 IDL> saveboxparam, filename
142 </div>
143          <h3>Version history</h3>
144         
145         
146          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
147                      June 2005</div>
148         
149         
150          <h3>Known issues</h3>
151         
152         
153         
154          <h4>Restrictions</h4><div class="value"> call def_myuniquetmpdir, if myuniquetmpdir is undefined:
155               => define, create and add it to !path
156</div>
157       
158          <h3>Other attributes</h3>
159         
160         
161          <h4>Uses routines</h4><div class="value"> cm_4mesh and cm_demomode_used if we are in demo mode
162</div>
163         
164         
165         
166       
167         
168       
169        </div>
170       
171      </div>
172
173     
174
175      <div id="tagline">Produced by IDLdoc 2.0.</div>
176
177    </div>
178
179  </body>
180</html>
Note: See TracBrowser for help on using the repository browser.