CDF_VARGET1
===========

The CDF_VARGET1 procedure reads one value from a CDF file variable.

Examples

See the example for CDF_VARCREATE.

Syntax

CDF_VARGET1, Id, Variable, Value [, OFFSET=vector] [, REC_START=record] $
             [, /STRING{data in CDF file must be type CDF_CHAR or CDF_UCHAR}] $
             [, /ZVARIABLE]

Arguments

Id

The CDF ID, returned from a previous call to CDF_OPEN or CDF_CREATE.

Variable

A string containing the name or an integer containing the index of the 
variable being inquired.

Value

A named variable in which the value of the variable is returned.

Keywords

OFFSET

A vector specifying the array indices within the specified record(s) at which 
to begin reading. OFFSET is a 1-dimensional array containing one element per 
CDF dimension. The default value is 0 for each dimension.

REC_START

The record number at which to start reading. The default is 0.

STRING

Set this keyword to return CDF_CHAR and CDF_UCHAR data from the CDF file into 
Value as string data rather than byte data. This keyword is ignored if the data 
in the CDF file is not of type CDF_CHAR or CDF_UCHAR. 

ZVARIABLE

If Variable is a variable ID (as opposed to a variable name) and the variable 
is a zVariable, set this flag to indicate that the variable ID is a zVariable 
ID. The default is to assume that Variable is an rVariable ID.

Examples

See the example for CDF_VARCREATE.

Version History

Pre 4.0

Introduced

© 2015 Exelis Visual Information Solutions, Inc., a subsidiary of Harris 
Corporation. All Rights Reserved. This information is not subject to the 
controls of the International Traffic in Arms Regulations (ITAR) or the Export 
Administration Regulations (EAR). However, this information may be restricted 
from transfer to various embargoed countries under U.S. laws and regulations.