ADIC 601355 Rev A Benutzerhandbuch

2-874

API Functions

601355 Rev A

VSID_QUERY_OPTION 
(VST_QUERY_OPTION)

Indicates whether information is being 
requested for a single specified drive pool or 
for all drive pools. Valid 

VSE_QUERY_OPTION

 

values are enumerated in the vs_types.h file.

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 
Drive Pool Query commands. 

VSID_RETRY_LIMIT

 is not applicable when 

the API software executes in asynchronous 
mode. The default retry limit is 3.

VSID_STATUS_WAIT_FLAG 
(VST_STATUS_WAIT_FLAG)

Flag indicating whether the API software waits 
for final status from VolServ (or times-out) for 
Drive Pool Query commands. Valid options 
are 

VSE_TRUE

 (API software waits for final 

status) and 

VSE_FALSE

 (API software 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 Drive Pool 

Query 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 Drive Pool Query 
commands. Neither the API software nor 
VolServ uses 

USER_FIELD

.