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

VSinquire/vsfinq

intn VSinquire(int32 vdata_id, int32 *n_records, int32 *interlace, char *fields, int32 *vdata_size, char *vdata_name)
vdata_id

IN:

Vdata access identifier returned from VSattach

n_records

OUT:

Number of records in the vdata

interlace

OUT:

Interlace type

fields

OUT:

Comma-separated string listing all fields in the vdata (e.g. "PX, PY,PZ")

vdata_size

OUT:

Size, in bytes, of a record in the vdata for the local machine

vdata_name

OUT:

Name, if any, of the vdata

Purpose

General vdata inquiry routine.

Return value

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

Description

VSinquire retrieves the information for each of the variables listed above. If any of the parameters are NULL, that data is not retrieved. Refer to the Reference Manual pages on VSgetfields, VSgetinterlace, VSsizeof and VSgetname.

Valid values for interlace are: FULL_INTERLACE or NO_INTERLACE.

FORTRAN

integer function vsfinq(vdata_id, n_records, interlace, fields, vdata_size, vdata_name)

integer vdata_id, n_records, interlace, vdata_size

character* (*) fields, vdata_name



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

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