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

1.10 Obsolete Vgroup Interface Routines

The following routines have been replaced by newer routines with similar functionality. They are still supported by the HDF V interface, but their use is not recommended. HDF may not support these routines in a future version.

1.10.1 Determining the Next Vgroup or Vdata Identifier: Vgetnext

Vgetnext searches through a vgroup for vgroups or vdatas. The syntax for Vgetnext is:

C:		ref_num = Vgetnext(vgroup_id, vgroup_ref);

FORTRAN:	ref_num = vfgnxt(vgroup_id, vgroup_ref)

Vgetnext searches the vgroup with the identifier vgroup_id and returns the reference number of the vgroup or vdata following the vgroup with the reference number specified by the vgroup_ref parameter. To initiate the search, Vgetnext is called with vgroup_ref set to -1. This will return the reference number of the first object in the target vgroup. The value -1 is returned when an error occurs or when there are no more entities in the host vgroup.

Vgetnext is now obsolete as the routine Vgettagref provides the same functionality and, in addition, is not restricted to searching for members that are vgroups or vdatas.

1.10.2 Determining the Number of Members and Vgroup Name: Vinquire

The syntax for Vinquire is:

C:		status = Vinquire(vgroup_id, n_members, vgroup_name);

FORTRAN:	status = vfinq(vgroup_id, n_members, vgroup_name)

Vinquire returns the number of data objects and the name of the vgroup specified by vgroup_id in the n_members and vgroup_name parameters respectively. If either n_members or vgroup_name are set to NULL, the corresponding data is not returned. The maximum length of the vgroup's name is defined by the macro VGNAMELENMAX.

Vinquire is now obsolete as the Vntagrefs routine can be used to get the number of objects in a vgroup and Vgetname can be used to retrieve the name of a vgroup.

TABLE 5L Vgetnext and Vinquire Parameter List
Routine Name

(Fortran-77)

Parameter

Data Type

Description

C

Fortran-77

Vgetnext

(vfgnxt)

vgroup_id

int32

integer

Vgroup identifier of the parent vgroup.

vgroup_ref

int32

integer

Reference number for the target vgroup.

Vinquire

(vfinq)

vgroup_id

int32

integer

Vgroup identifier.

members

int32 *

integer

Pointer to the number of entries in the vgroup.

vgroup_name

char *

character* (*)

Buffer for the name of the vgroup.



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

hdfhelp@ncsa.uiuc.edu
HDF User's Guide - 06/04/97, NCSA HDF Development Group.