ADIC 601355 Rev A Destroy

API Guide

601355 Rev A API Functions 2-257

Functions

VS_Media_

Destroy VS_Media_Destroy deallocates a VolServ API media

handle that was allocated by VS_Media_Create. A media

destroy handle is used to pass media information to and from

Vol S e rv .

Synopsis VST_BOOLEAN VS_Media_Destroy

(VST_MEDIA_HANDLE handle)

Arguments •handle = The media handle to be destroyed.

Return Values VS_Media_Destroy returns:

•VSE_TRUE - Successful execution.

•VSE_FALSE - API failure - An appropriate error code is set

in VSG_Error.

•VSE_ERR_BADHANDLE - Specified handle was not a

media handle.

•VSE_ERR_NULLHANDLE - Specified handle was a null

pointer.

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

*********

3 * FUNCTION: vst_media_handle

5 * PURPOSE:

6 * This function tests a media handle.

8 * PARAMETERS:

9 * none

10 *

11 ****************************************

*********/