ADIC 601355 Rev A

API Guide

601355 Rev A API Functions 2-263

Functions

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

media handle.

•VSE_ERR_NULLHANDLE - Specified handle was a null

pointer.

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

*********

3 * FUNCTION: vst_print_media

5 * PURPOSE:

6 * This function prints out the

information stored

7 * in a media handle.

8 * PARAMETERS:

9 * h : the media handle to print

10 *

VSID_MOVE_COUNT (VST_COUNT *) Pointer to the number of times this medium

has been moved from one archive to another.

VSID_PENDING_ARCHIVE_NAME

(VST_ARCHIVE_NAME) Pointer to the 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