ADIC 601355 Rev A

API Guide

601355 Rev A API Functions 2-209

Functions

Parame ters

Return Values VS_Error_GetFields returns

•VSE_TRUE - Successful execution.

•VSE_FALSE - API failure - The appropriate error code is

set in VSG_Error.

•VSE_ERR_BADFIELD - An invalid parameter was

specified.

•VSE_ERR_BADHANDLE - Specified handle was not an

error handle.

•VSE_ERR_NULLHANDLE - Specified handle was a null

pointer.

Example 1 /****************************************

*********

3 * FUNCTION: vst_print_error

5 * PURPOSE:

Parameter Type Description

VSID_ERROR_CODE (VST_ERROR_CODE) Pointer to the error code for the given error.

VSID_ERROR_FILE (VST_ERROR_FILE) Name of the source file where the error

occurred (API internal errors only).

VSID_ERROR_LINE (int *) Pointer to the source line number where the

error occurred (API internal errors only).

VSID_ERROR_NUMBER

(VST_ERROR_NUMCODE *) Pointer to the field that indicates which error

occurred.

VSID_ERROR_OBJECT

(VST_ERROR_OBJCODE *) Pointer to the field that indicates the location

of the error.