[Back to Interface] [Prev] [Next]

VSattrinfo/vsfainf

intn VSattrinfo(int32 vdata_id, int32 field_index, intn attr_index, char *attr_name, int32 *data_type, int32 *count, int32 *size)

vdata_id IN:

Vdata identifier returned by VSattach

field_index IN:

Index of the field

attr_index IN:

Index of the attribute

attr_name OUT:

Name of the attribute

data_type OUT:

Data type of the attribute

count OUT:

Attribute value count

size OUT:

Size of the attribute

Purpose

Retrieves attribute information of a vdata or a vdata field.

Return value

Returns SUCCEED (or 0) if successful and FAIL (or -1) otherwise.

Description

VSattrinfo gets information on the attribute attached to the vdata, vdata_id, or to the vdata field. Vdata field is specified by its index, field_index. Attribute is specified by its index, attr_index. The attribute name is returned into the parameter attr_name, the data type is returned into the parameter data_type, the number of values of the attribute is returned into the parameter count, and the size of the attribute is returned into the parameter size.

The parameter field_index in VSattrinfo is the same as the parameter field_index in VSsetattr. It can be set to either an integer field index for the vdata field attribute, or _HDF_VDATA (or -1) to specify the vdata attribute.

In C the values of the parameters attr_name, data_type, count and size can be set to NULL if the information returned by these parameters is not needed.

FORTRAN

integer function vsfainf(vdata_id, field_index, attr_index, attr_name, data_type, count, size)

integer vdata_id, field_index, attr_index

character*(*) attr_name

integer data_type, count, size



[Back to Interface] [Prev] [Next]

hdfhelp@ncsa.uiuc.edu
HDF Reference Manual - 07/29/98, NCSA HDF Development Group.