NCDF_VARINQ

Syntax | Return Value | Arguments | Examples | Version History

The NCDF_VARINQ function returns a structure that contains information about a netCDF variable, given its ID. This structure has the form: 

{ NAME:"", DATATYPE:"", NDIMS:0L, NATTS:0L, DIM:LONARR(NDIMS) }

This structure is described below.

Syntax

Result = NCDF_VARINQ(Cdfid, Varid)

Return Value

The returned structure contains the following tags:

Table 6-4: NCDF_VARINQ Structure Tags

Tag
Description

Name

The name of the variable.

DataType

A string describing the data type of the variable. The string will be one of the following: 'BYTE', 'CHAR', 'INT', 'LONG', 'FLOAT', or 'DOUBLE'.

Ndims

The number of dimensions.

Natts

The number of attributes assigned to this variable.

Dim

A vector of the dimension IDs for the variable dimensions.

Arguments

Cdfid

The netCDF ID, returned from a previous call to NCDF_OPEN or NCDF_CREATE.

Varid

The netCDF variable ID, returned from a previous call to NCDF_VARDEF or NCDF_VARID, or the name of the variable.

Examples

See NCDF_VARDEF.

Version History

Pre 4.0

Introduced