ADIC 601355 Rev A

API Guide

601355 Rev A API Functions 2-269

Functions

Return Values VS_Media_SetFields 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

media handle.

•VSE_ERR_BADSIZE - The value passed for a string

parameter exceeds the maximum allowable length for that

parameter.

•VSE_ERR_NULLHANDLE - Specified handle was a null

pointer.

•VSE_ERR_NULLSTRING - A null value was passed to a

string argument.

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

*********

3 * FUNCTION: vst_media_handle

5 * PURPOSE:

6 * This function tests a media handle.

8 * PARAMETERS:

9 * none

VSID_PENDING_ARCHIVE_NAME

(VST_ARCHIVE_NAME) Name of the destination archive for this

medium. Valid archive names may contain up

to 16 alphanumeric characters, including

spaces. Leading and trailing spaces are not

permitted.

Parameter Type Description