NAME

var_info -- show index range of assigned elements

PROTOTYPE

unitptr var_info( char *pcName, int iNum, char *pcOptions, unitptr uHost)

ARGUMENTS

char *pcName
name of variable set
int iNum
nr of dimensions; if specified as 0, the unit will only check for the existence of a var_def unit with the given name.
char *pcOptions
options
unitptr uHost
host unit

RETURN VALUE:

A pointer to the created unit or NULL in the case of an error.

INTERFACE OF CREATED UNIT:

Depends on chose option. Default:

X_out[iNum]:
(output field 0) for each of the iNum dimensions of the associated var_def unit the lowest index bound iLimit such that all assigned index locations are below iLimit (i.e., iLimit is the highest index used so far plus 1)
If iNum=0 or option %? is given, unit just checks for presence of specified var_def unit:
X_out[1]:
(output field 0) 1, if a var_def unit with the given name exists, 0 otherwise.
Y_out[]:
(output field 1) a string with the interface of the first vardef unit that was found with the given name, the empty string otherwise.

EXECUTION OF CREATED UNIT:

Update index limit vector X_out[].

DESCRIPTION:

This unit is provided to facilitate iterations over data sets held in var_def units. By using 0 and X_out[k] as index limits in a for_loop, all assigned elements along dimension k can be traversed.

STATUS:

Preliminary.

SEE ALSO:

FILE

/amnt/loge/users/nistaff02/nistaff/rhaschke/nst7/man/../o.linux//../nstsrc/nst_var.c