[Top] [Prev] [Next]

5.9 Obsolete Vgroup Interface Routines

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

5.9.1 Determining the Next Vgroup or Vdata Identifier: Vgetnext

Vgetnext gets the reference number of the next member of a vgroup. This member can be either a vgroup or vdata. The syntax for Vgetnext is as follows:

C:		ref_num = Vgetnext(vgroup_id, v_ref);
FORTRAN:	ref_num = vfgnxt(vgroup_id, v_ref)
Vgetnext searches the vgroup, identified by the parameter vgroup_id, for the vgroup or vdata whose reference number is specified by the parameter v_ref. If this vgroup or vdata is found, Vgetnext finds the next vgroup or vdata and returns its reference number. If v_ref is set to -1, the routine will return the reference number of the first vgroup or vdata in the vgroup.

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

Vgetnext returns a reference number if the next vgroup or vdata is found, or FAIL (or -1) when an error occurs or when there are no more vdatas or vgroups in the vgroup. The parameters of Vgetnext are further defined in Table 5N.

5.9.2 Determining the Number of Members and Vgroup Name: Vinquire

Vinquire retrieves the number of data objects and the name of the vgroup identified by the parameter vgroup_id. The syntax for Vinquire is as follows:

C:		status = Vinquire(vgroup_id, &n_members, vgroup_name);
FORTRAN:	status = vfinq(vgroup_id, n_members, vgroup_name)
Vinquire stores the number of data objects and the vgroup name in the parameters n_members and vgroup_name, respectively. In C, if either n_members or vgroup_name is set to NULL, the corresponding data is not returned. The maximum length of the vgroup's name is defined by VGNAMELENMAX (or 64).

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

Vinquire returns either SUCCEED (or 0) or FAIL (or -1). The parameters of this routines are further defined in Table 5N.

TABLE 5N - Vgetnext and Vinquire Parameter Lists

Routine Name

[Return Type]

(FORTRAN-77)
Parameter
Parameter Type
Description
C
FORTRAN-77
Vgetnext

[int32]

(vfgnxt)
vgroup_id
int32
integer
Vgroup identifier of the parent vgroup

v_ref
int32
integer
Reference number for the target vgroup

Vinquire

[intn]

(vfinq)
vgroup_id
int32
integer
Vgroup identifier

n_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]

hdfhelp@ncsa.uiuc.edu
HDF User's Guide - 07/21/98, NCSA HDF Development Group.