ADIC 601355 Rev A VSCMD_Ping

API Guide
601355 Rev A API Functions 2-1009
Functins
VSCMD_Ping VSCMD_Ping checks the availability of VolServ. If VolServ
responds to a VSCMD_Ping request, it can be assumed by the
client that the VolServ is available and functioning.
The client is not required to issue a VSCMD_Ping request
before sending other requests to the VolServ system.
Upon receiving a VSCMD_Ping request, VolServ
immediately returns a VolServ process identifier number. No
other processing is executed for a VSCMD_Ping command.
Synopsis VST_BOOLEAN VSCMD_Ping
(VST_COMMAND_HANDLE handle)
Arguments •handle = The command handle for this Ping request.
Return Values VSCMD_Ping returns:
•VSE_TRUE
- Successful execution if the API is operating in
synchronous mode
- Good initial status received if the API is operating in
asynchronous mode
•VSE_FALSE - The request failed. A return code of
VSE_FALSE (which is 0) means the request failed.
- To determine where the error occurred, and what the
error was, the client queries the request’s error handle
(with VS_Error_GetFields) to retrieve the error
handle’s object code.