API Guide
601355 Rev A API Functions 2-15
Functions
VS_Archive_
GetFields VS_Archive_GetFields retrieves information associated
with an archive handle. An archive handle is used to pass
archive information to and from VolServ.
Synopsis VST_BOOLEAN VS_Archive_GetFields
(VST_ARCHIVE_HANDLE handle,
“…”,
VSID_ENDFIELD )
Arguments •handle = Archive handle where information is retrieved.
•“…” = Variable length argument list consisting of pairs of
arguments. Each pair of arguments consists of a parameter
identifier, followed by a pointer to a location where the
value of the parameter may be stored. The parameter
identifiers and types this function accepts are shown in the
following "Parameters" paragraph.
•VSID_ENDFIELD = Required at the end of the variable
length argument list to indicate the end of the list.
Parame ters
Parameter Type Description
VSID_ARCHIVE_CONFIG_STATE
(VST_ARCHIVE_CONFIG_STATE*) Pointer to a boolean flag that indicates
whether the archive is currently being
configured or reconfigured.
Valid VSID_ARCHIVE_CONFG_STATE values
are enumerated in the vs_types.h file.
VSID_ARCHIVE_CONSOLE_LOCATION
(VST_HOSTNAME) Pointer to the location of the archive’s console
display.