API Guide
601355 Rev A API Functions 2-1079
Functins
• The first argument passed is the number of drives to unlock.
• The second argument is the list of identifiers of the drives to
unlock.
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.
When the API software is operating in asynchronous mode,
client software must call VS_Select to receive intermediate
and final status on an Unlock 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 Unlock
commands are set with VSCMD_Unlock_SetDefaults. If
command-specific defaults are set for Unlock commands,
they override the global defaults for all commands.
The following fields can be retrieved from the status handle
after a successful Unlock request:
• VSID_DRIVE_ID,
Tip
To override a default (global or command-specific)
parameter value for a specific instance of an Unlock
command, the parameter identifier and the value to be
used for the parameter can be submitted on the specific
request itself.