API Guide
601355 Rev A API Functions 2-713
Functions
VSID_DRIVE_ID_LIST (int) Number of drives in list.
(VST_DRIVE_ID *) Pointer to a list of drives to lock.
VSID_DRIVEPOOL_NAME
(VST_DRIVEPOOL_NAME)
The drive pool of drives to lock. Valid drive
pool names may contain up to 16
alphanumeric characters, including spaces.
Leading and trailing spaces are not permitted.
VSID_ENTERPRISE_ID
(VST_ENTERPRISE_ID)
Identifier of the enterprise, if any, to receive
final status for Lock commands.
VSID_PRIORITY (VST_PRIORITY) The execution priority for Lock commands.
Assignable priority values are restricted to the
range from 1 (highest) to 32 (lowest) inclusive.
The default priority value is 15.
VSID_RETRY_LIMIT (VST_RETRY_LIMIT) Number of times the API software retries for
command status from VolServ before
returning a time-out to the client software (to
override the default global retry limit) for Lock
commands. VSID_RETRY_LIMIT is not
applicable when the API software executes in
asynchronous mode.
VSID_STATUS_WAIT_FLAG
(VST_STATUS_WAIT_FLAG)
Flag indicating whether the API software waits
for final status from VolServ (or times-out) for
a command. Valid options are VSE_TRUE
(API waits for final status) and VSE_FALSE
(API does not wait for final status).Also
determines whether the API software
operates in synchronous mode (VSE_TRUE)
or in asynchronous mode (VSE_FALSE). The
default VSID_STATUS_WAIT_FLAG value is
VSE_TRUE.
VSID_TIMEOUT_VALUE (VST_TIME_OUT) Amount of time (in seconds) the API software
waits for status from VolServ before returning
a time-out to the client software. The default
time-out value is 120 seconds.
Parameter Type Description