API Guide
2-80 API Functions 601355 Rev A
Return Values VS_Command_GetStatusFields 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
command handle.
•VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
VSID_TARGET_ENTERPRISE_ID
(VST_ENTERPRISE_ID *) Pointer to the enterprise identifier for a
ConnectQuery or Disconnect command.
VSID_USER_FIELD (VST_USER_FIELD) Pointer to the user field contents for the
associated command. 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.
VSID_WAIT_REASON
(VST_WAIT_REASON *) Pointer to the wait reason for an intermediate
status. Valid VSID_WAIT_REASON values are
enumerated in the vs_types.h file.
Parameter Type Description