API Guide
2-460 API Functions 601355 Rev A
VSCMD_
ArchiveQuery VSCMD_ArchiveQuery queries for information associated
with a VolServ archive.
Upon receipt of an Archive Query command, VolServ obtains
information about the specified archive. This information is
returned to the client in the status of the command.
Synopsis VST_BOOLEAN VSCMD_ArchiveQuery
(VST_COMMAND_HANDLE handle,
“…”,
VSID_ENDFIELD)
Arguments •handle = The command handle for the Archive Query
command.
•“…” = 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 use for this
command. 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_NAME
(VST_ARCHIVE_NAME) Name of the archive to be queried. Valid
archive names may contain up to 16
alphanumeric characters, including spaces.
Leading and trailing spaces are not permitted.