ADIC 601355 Rev A

API Guide

601355 Rev A API Functions 2-747

Functions

- To determine where the error occurred, and what the

error was, the client queries the command’s error

handle (with VS_Error_GetFields) to retrieve

the error handle’s object code.

- If the object code’s value is VSE_NONE, the client

must query the global error code (VSG_Error) to

determine where the error occurred.

•VSE_ERR_BADHANDLE - Specified handle was not a valid

command handle.

•VSE_ERR_NULLHANDLE - Specified handle was a null

pointer.

- If the object code’s value is VSE_VOLSERV, the

error occurred in VolServ, and the client uses

VST_ERROR_NUMCODE to identify the specific

error.

- If the object code’s value is not VSE_VOLSERV

and is not VSE_NONE, the error occurred in the

API, and the client uses VST_ERROR_CODE to

identify the specific error.

•VSE_ERR_BADFIELD - An invalid parameter was

specified.

•VSE_ERR_BADSIZE - Value passed for a string parameter

exceeds the maximum allowable length for that parameter.

•VSE_ERR_NOTINITIALIZED - The VolServ API is not

initialized.

•VSE_ERR_NULLSTRING - A null value was passed to a

string argument.