ADIC 601355 Rev A User Manual

601355 Rev A

API Functions

2-667

When the API software is operating in asynchronous mode, 
client software must call 

VS_Select

 to receive intermediate 

and final status on command requests 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 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 the Export 
command are set with 

VSCMD_Export_SetDefaults

. If 

command-specific defaults are set for all commands, they 
override the global defaults for all commands.

The following fields can be retrieved from the status handle 
after a successful Export request: 

•

VSID_ERROR_CODE

,

 

•

VSID_ERROR_CODE_ENTRY

,

•

VSID_ERROR_CODE_TABLE

,

•

VSID_MEDIA_ID

, 

•

VSID_MEDIA_ID_ENTRY

,

•

VSID_MEDIA_ID_TABLE

, 

•

VSID_SEQUENCE_NUM

, 

To override a default (global or command-specific) 
parameter value for a specific instance of an Export 
command, the parameter identifier and the value to be 
used for the parameter can be submitted on the command 
itself.