ADIC 601355 Rev A Benutzerhandbuch

2-240

API Functions

601355 Rev A

VS_Global_GetFields

 returns:

•

VSE_TRUE

 - Successful execution.

•

VSE_FALSE

 - API failure - The appropriate error code is 

set in

 VSG_Error.

•

VSE_ERR_BADFIELD

 - An invalid parameter was 

specified. 

VSID_STATUS_WAIT_FLAG 
(VST_STATUS_WAIT_FLAG*) 

Pointer to a flag that indicates whether the API 
software is to wait for final status from VolServ 
(or to time-out) for a request. Valid options are 

VSE_TRUE

 (API is to wait for final status) and 

VSE_FALSE

 (API is not to wait for final status). 

Also determines whether the API software 
operates in synchronous mode (

VSE_TRUE

) 

or in asynchronous mode (

VSE_FALSE

). 

Default value is 

VSE_TRUE

.

VSID_SYNC_PROGRAM_NUMBER 
(VST_PROGRAM_NUMBER *) 

Pointer to the RPC program number to use for 
synchronous processing.

VSID_TIMEOUT_VALUE (VST_TIME_OUT *) 

Pointer to the amount of time (in seconds) the 
API software is to wait for status from VolServ 
before returning a time-out to the client 
software. Default time-out value is 120 
seconds.

VSID_USER_FIELD (VST_USER_FIELD) 

Pointer to the default value to be placed in the 

VSID_USER_FIELD

 for every command 

request. 

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 each 
command. Neither the API software nor 
VolServ uses 

USER_FIELD

.