API Guide
2-350 API Functions 601355 Rev A
Return Values VS_Notify_GetFields returns:
•VSE_TRUE - Successful execution.
•VSE_FALSE - API failure - An appropriate error code is set
in VSG_Error.
•VSE_ERR_BADFIELD- An invalid parameter was
specified.
•VSE_ERR_BADHANDLE - Specified handle was not a
notify handle.
•VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
VSID_PROTOCOL (VST_PROTOCOL *) Pointer to the RPC protocol the API should
use for callbacks. Valid VSID_PROTOCOL
values for this field are enumerated in the
vs_types.h file.
VSID_STATUS_CODE
(VST_STATUS_CODE *) Pointer to the status code stating whether the
enter or eject passed or failed.
VSID_STATUS_CODE is returned only for
enter and eject callbacks.
VSID_TARGET_MEDIA_CLASS_NAME
(VST_MEDIA_CLASS_NAME) Pointer to the target MediaClass name for this
callback.
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. The default time-out value is 120
seconds.
VSID_VERSION_NUMBER
(VST_VERSION_NUMBER *) Pointer to the RPC version number the API
should use to receive callbacks.
Parameter Type Description