[Top] [Prev] [Next] [Bottom]

VSgetid/vsfgid

int32 VSgetid(int32 file_id, int32 vdata_ref)
file_id

IN:

File identifier returned by Hopen

vdata_ref

IN:

Reference number for the vdata preceding the vdata of interest

Purpose

Sequentially searches through an HDF file for vdatas.

Return value

Returns the reference number for the next vdata if successful and FAIL (or -1) otherwise.

Description

VSgetid searches through the specified HDF file and returns the reference number of the next vdata after the vdata that has reference number vdata_ref. This routine is generally used to sequentially search the file for vdatas.

To initiate a search, this routine must be called with vdata_ref equal to -1. Doing so returns the reference number of the first vdata in the file. Searching past the last vdata in a file will result in an error condition.

FORTRAN

integer function vsfgid(file_id, vdata_ref)

integer file_id, vdata_ref



[Top] [Prev] [Next] [Bottom]

hdfhelp@ncsa.uiuc.edu
HDF User's Reference Manual, Draft 06/09/97, NCSA HDF Development Group.