API Guide
601355 Rev A API Functions 2-69
Functions
Return Values
VS_Command_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
command handle.
• VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
Example 1 /****************************************
*********
2*
3 * FUNCTION: vst_print_command
4*
5 * PURPOSE:
6 * This function prints out the
information stored in
7 * a command handle.
8*
9 * PARAMETERS:
10 * h : the command handle to print
11 *
VSID_REQUEST_TYPE
(VST_REQUEST_TYPE *)
Pointer to the type of command. Valid
VSID_REQUEST_TYPE values are
enumerated in the vs_type.h file.
VSID_STATUS_HANDLE
(VST_STATUS_HANDLE *)
Pointer to the status handle associated with
this command.
Parameter Type Description
