source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/idl-NetCDF/ncdf_listvars.html

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

update documentation
File size: 4.2 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>ncdf_listvars.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="ncdf_listvars.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="../../../../ReadWrite/idl-NetCDF//ncdf_listvars.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="ncdf_listdims.html">&lt;&lt;prev file</a> | <a href="ncdf_read.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_listvars.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">ReadWrite/idl-NetCDF/</a></h1>
82      <h2 class="pro_file">ncdf_listvars.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 give back the liste of variables included in a NetCDF file
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_ncdf_listvars">
105
106          <h2><a class="top" href="#container">top</a>ncdf_listvars <span class="categories"> 
107 NetCDF
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>ncdf_listvars(<span class="result"><a href="#_ncdf_listvars_param_input">input</a></span>)</p>
112       
113          <div class="comments"></div>
114
115          <h3>Return value</h3><div class="preformat">
116 a vector string containing the name of the variables
117</div>
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_ncdf_listvars_param_input">input&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124              <span class="attr">in</span>
125             
126             
127              <span class="attr">required</span>
128             
129              <span class="attr">type:</span> <span class="value">salar string or long integer</span>
130             
131             
132            </h4>
133       
134          <div class="comments"> 
135 the name of the file or its Id (defined by a previus call to
136 ncdf_open or ncdf_create)
137 Note that if input corresponds to the file name, ncdf_listvars will
138 open and close the file automatically.
139</div>
140           
141
142         
143
144         
145
146          <h3>Examples</h3><div class="preformat">
147
148   IDL> varnames = ncdf_listvars('toto.nc')
149
150   or
151
152   IDL> i=ncdf_open('toto.nc')
153   IDL> varnames = ncdf_listvars(id)
154 </div>
155          <h3>Version history</h3>
156         
157          <h4>Version</h4><div class="preformat">
158 $Id: ncdf_listvars.pro 371 2008-08-07 09:32:02Z pinsard $
159</div>
160          <h4>History</h4><div class="preformat">
161
162</div>
163         
164         
165         
166         
167         
168         
169         
170       
171         
172         
173         
174         
175         
176         
177         
178       
179          <h3>Statistics</h3>
180          <table class="statistics">
181            <tr><td>McCabe cyclic</td><td>           4</td></tr>
182            <tr><td>McCabe essential</td><td>           1</td></tr>
183            <tr><td>McCabe modular design</td><td>           1</td></tr>
184          </table>
185         
186       
187        </div>
188       
189      </div>
190
191     
192
193      <div id="tagline">Produced by IDLdoc 2.0.</div>
194
195    </div>
196
197  </body>
198</html>
Note: See TracBrowser for help on using the repository browser.