API Guide
601355 Rev A API Functions 2-25
Functions
VS_Archive_
SetFields VS_Archive_SetFields sets the value of one or more
field in an archive handle. An archive handle is used to pass
archive information to and from VolServ.
Synopsis VST_BOOLEAN VS_Archive_SetFields
(VST_ARCHIVE_HANDLE
handle,
“…”,
VSID_ENDFIELD )
Arguments •handle = Archive handle where information is stored.
•“…” = Variable length argument list consisting of pairs of
arguments. Each pair of arguments consists of a parameter
identifier, followed by the value of the field to store. 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) A boolean flag that indicates whether the
archive is currently being configured or
reconfigured. Valid
VSID_ARCHIVE_CONFIG_STATE values are
enumerated in the vs_types.h file.
VSID_ARCHIVE_CONSOLE_LOCATION
(VST_HOSTNAME) The location of the archive’s console display.