API Guide
601355 Rev A API Functions 2-825
Functions
The total length of time the API software waits for a command
status in synchronous mode from VolServ is
(VSID_RETRY_LIMIT plus 1) multiplied by
VSID_TIMEOUT_VALUE.
If the VSID_ENTERPRISE_ID parameter is set to any value
other than zero, the final status for this request is returned to the
enterprise registered with VolServ.
When the API software is operating in asynchronous mode,
client software must call VS_Select to receive final status on
a Delete Pool request submitted through the API interface to the
VolServ system.
Two levels of default parameter settings are used in the API
software— global defaults and command-specific defaults.
• Global defaults for all commands are initialized at startup
and can be set or retrieved using VS_Global_SetFields
and VS_Global_GetFields function calls.
• Command-specific parameter defaults for Delete Pool
commands are set with
VSCMD_DeletePool_SetDefaults. If
command-specific defaults are set for Delete Pool
commands, they override the global defaults for all
commands.
The following fields can be retrieved from the status handle
after a successful Delete Pool request:
Tip
To override a default (global or command-specific)
parameter value for a specific instance of a Delete Pool
command, the parameter identifier and the value to be
used for the parameter can be submitted on the specific
request itself.