API Guide
601355 Rev A API Functions 2-541
Functions
When the API software is operating in asynchronous mode,
client software must call VS_Select to receive intermediate
and final status on a Checkout 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 Checkin
commands are set with VSCMD_Checkout_SetDefaults.
If command-specific defaults are set for Checkout
commands, they override the global defaults for all
commands.
The following fields can be retrieved from the status handle
after a successful Checkout request:
•VSID_ERROR_CODE,
• VSID_ERROR_CODE_ENTRY,
• VSID_ERROR_CODE_TABLE,
•VSID_MEDIA_ID,
• VSID_MEDIA_ID_ENTRY,
• VSID_MEDIA_ID_TABLE,
Tip
To override a default (global or command-specific)
parameter value for a specific instance of a Checkout
command, the parameter identifier and the value to be
used for the parameter can be submitted on the specific
request itself.