The HDF Group

HDF Reference Manual

Version 4.2.12


[VF Interface][Top]


VFfieldesize/vffesiz

int32 VFfieldesize(int32 vdata_id, int32 field_index)

vdata_id
IN:
Vdata identifier returned by VSattach
field_index
IN:
Vdata field index

Purpose
Returns the size, as stored on disk, of a vdata field.
Return value
Returns the vdata field size if successful and FAIL (or -1) otherwise.
Description
VFfieldesize returns the size, as stored on disk, of a vdata field identified by the parameter field_index in the vdata identified by the parameter vdata_id.
 
The value of the parameter field_index ranges from 0 to the total number of fields in the vdata - 1. The number of vdata fields is returned by VFnfields function.

FORTRAN
integer function vffesiz(vdata_id, field_index)
 
integer vdata_id, field_index

[VF Interface][Top]


VFfieldisize/vffisiz

int32 VFfieldisize(int32 vdata_id, int32 field_index)

vdata_id
IN:
Vdata identifier returned by VSattach
field_index
IN:
Vdata field index

Purpose
Returns the size, as stored in memory, of a vdata field.
Return value
Returns the vdata field size if successful and FAIL (or -1) otherwise.
Description
VFfieldisize returns the size, as stored in memory, of a vdata field identified by the parameter field_index in the vdata identified by the parameter vdata_id.
 
The value of the parameter field_index ranges from 0 to the total number of fields in the vdata - 1. The number of vdata fields is returned by VFnfields function.

FORTRAN
integer function vffisiz(vdata_id, field_index)
 
integer vdata_id, field_index

[VF Interface][Top]


VFfieldname/vffname

char *VFfieldname(int32 vdata_id, int32 field_index)

vdata_id
IN:
Vdata identifier returned by VSattach
field_index
IN:
Vdata field index

Purpose
Returns the name of a vdata field.
Return value
Returns a pointer to the vdata field name if successful and NULL otherwise. The FORTRAN-77 version of this routine, vffname, returns SUCCEED (or 0) or FAIL (or -1).
Description
VFfieldname returns the name of the vdata field identified by the parameter field_index in the vdata identified by the parameter vdata_id.
 
The value of the parameter field_index ranges from 0 to the total number of fields in the vdata - 1. The number of vdata fields is returned by VFnfields function.
 
The FORTRAN-77 version of this routine, vffname, returns the field name in the parameter fname.

FORTRAN
integer function vffname(vdata_id, field_index, fname)
 
integer vdata_id, field_index
 
character*(*) fname

[VF Interface][Top]


VFfieldorder/vffordr

int32 VFfieldorder(int32 vdata_id, int32 field_index)

vdata_id
IN:
Vdata identifier returned by VSattach
field_index
IN:
Vdata field index

Purpose
Returns the order of a vdata field.
Return value
Returns the order of the field if successful and FAIL (or -1) otherwise.
Description
VFfieldorder returns the order of the vdata field identified by its index, field_index, in the vdata identified by the parameter vdata_id.
 
The value of the parameter field_index ranges from 0 to the total number of fields in the vdata - 1. The number of vdata fields is returned by VFnfields function.

FORTRAN
integer function vffordr(vdata_id, field_index)
 
integer vdata_id, field_index

[VF Interface][Top]


VFfieldtype/vfftype

int32 VFfieldtype(int32 vdata_id, int32 field_index)

vdata_id
IN:
Vdata identifier returned by VSattach
field_index
IN:
Vdata field index

Purpose
Returns the data type of a vdata field.
Return value
Returns the data type if successful and FAIL (or -1) otherwise.
Description
VFfieldtype returns the data type of the vdata field identified by its index, field_index, in the vdata identified by the parameter vdata_id.
 
The value of the parameter field_index ranges from 0 to the total number of fields in the vdata - 1. The number of vdata fields is returned by VFnfields function.

FORTRAN
integer function vfftype(vdata_id, field_index)
 
integer vdata_id, field_index

[VF Interface][Top]


VFnfields/vfnflds

int32 VFnfields(int32 vdata_id)

vdata_id
IN:
Vdata identifier returned by VSattach

Purpose
Returns the total number of fields in a vdata.
Return value
Returns the total number of fields if successful and FAIL (or -1) otherwise.
Description
VFnfields returns the total number of fields in the vdata identified by the parameter vdata_id.

FORTRAN
integer function vfnflds(vdata_id)
 
integer vdata_id


HDF 4.2.12 - June 2016
Copyright
The HDF Group
www.hdfgroup.org
The HDF Group