ADIC 601355 Rev A User Manual

2-670

API Functions

601355 Rev A

(char **)

Array of media identifiers to export.

VSID_PRIORITY (VST_PRIORITY)

The execution priority (to override the default 
global execution priority) for Export 
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 for 
Export 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.

VSID_USER_FIELD (VST_USER_FIELD)

Value to be put in 

USER_FIELD

 for Export 

commands. 

USER_FIELD

 is a 16-character 

field provided for user information. Information 
entered in this field is echoed back to the user 
in every status message returned for Export 
commands. Neither the API software nor 
VolServ uses 

USER_FIELD

.