Changeset 321 for trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/idl-NetCDF

Timestamp:

12/03/07 16:41:25 (17 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/idl-NetCDF/ncdf_listvars.html (modified) (5 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/idl-NetCDF/ncdf_listvars.html

@@ -62 +62 @@
 
     
-
+ give back the liste of variables included in a NetCDF file
 
 
@@ -70 +70 @@
       <a name="#_ncdf_listvars"></a>
 
-      <h2>ncdf_listvars  <font size="-1" color="#006633">
-
+      <h2>ncdf_listvars  <font size="-1" color="#006633"> 
+ NetCDF
 </font></h2>
 
-      <p><font face="Courier"><i>result = </i>ncdf_listvars(<i><a href="#_ncdf_listvars_keyword_ncid">ncid</a></i>)</font></p>
+      <p><font face="Courier"><i>result = </i>ncdf_listvars(<i><a href="#_ncdf_listvars_keyword_input">input</a></i>)</font></p>
 
     
 
     <h3>Return value</h3>
-
+ a vector string containing the name of the variables
 
 
@@ -86 +86 @@
     
 
-    <a name="#_ncdf_listvars_keyword_ncid"></a>
-    <h4>ncid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+    <a name="#_ncdf_listvars_keyword_input"></a>
+    <h4>input&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+      <font size="-1" color="#006633">in</font>
       
       
+      <font size="-1" color="#006633">required</font>
       
-      
-      
-      
+      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>salar string or long integer</i></font>
       
       
     </h4>
 
-    
- 
+     
+ the name of the file or its Id (defined by a previus call to
+ ncdf_open or ncdf_create)
+ Note that if input corresponds to the file name, ncdf_listvars will
+ open and close the file automatically.
 
     
@@ -107 +110 @@
 
     <h3>Examples</h3><pre>
- 
+ IDL> varnames = ncdf_listvars('toto.nc')
+   or
+ IDL> i=ncdf_open('toto.nc')
+ IDL> varnames = ncdf_listvars(id)
  
     </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: ncdf_listvars.pro 157 2006-08-21 09:01:50Z navarro $
+ $Id: ncdf_listvars.pro 308 2007-11-05 10:20:28Z smasson $
 
     <h4>History</h4>
@@ -119 +125 @@
     
 
-    <h3>Known issues</h3>
     
     
     
-    <h4>Restrictions</h4>
-
-
+    
+