The HDF_VD_GET procedure is a general VData inquiry routine. Set the various keywords to named variables to return information about a VData in an HDF file.
Examples
HDF_VD_GET, vdat, CLASS=c, COUNT=co, FIELDS=f, NAME=n, SIZE=s
Syntax
HDF_VD_GET, VData [, CLASS=variable] [, COUNT=variable] [, FIELDS=variable] [, INTERLACE=variable] [, NAME=variable] [, NFIELDS=variable] [, REF=variable] [, SIZE=variable] [, TAG=variable]
Arguments
VData
A VData handle returned by HDF_VD_ATTACH.
Keywords
CLASS
Set this keyword to a named variable in which the class name of the VData is returned as a string.
COUNT
Set this keyword to a named variable in which a long, containing the number of records in the VData, is returned.
FIELDS
Set this keyword to a named variable in which a comma-separated string of fields in the VData is returned (e.g., 'PX,PY,PZ')
The maximum number of fields is 256. Each field can be up to 128 characters in length. The returned fields may or may not contain buffering whitespace depending on how the HDF file was created.
INTERLACE
Set this keyword to a named variable in which a string, containing either 'FULL_INTERLACE' or 'NO_INTERLACE', is returned.
NAME
Set this keyword to a named variable in which a string, containing the name of the VData, is returned.
NFIELDS
Set this keyword to a named variable in which a long, containing the number of fields in the VDATA, is returned. For example, the VData containing the fields “PX,PY,PZ”, has an NFIELDS of 3.
REF
Set this keyword to a named variable in which the reference number of the VData is returned.
SIZE
Set this keyword to a named variable in which a long, containing the local size of a record of VData, is returned.
TAG
Set this keyword to a named variable in which the tag number of the VData is returned.
Version History
See Also
HDF_VD_GETINFO, HDF_VG_GETINFO