API Guide
601355 Rev A API Functions 2-11
Functions
VS_Archive_
Destroy
VS_Archive_Destroy deallocates an archive handle that
was allocated with VS_Archive_Create. An archive
handle is used to pass archive information to and from VolServ.
Synopsis
VST_BOOLEAN VS_Archive_Destroy
(VST_ARCHIVE_HANDLE handle)
Arguments • handle = Archive handle to destroy.
Return Values
• VS_Archive_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 an
archive handle.
• VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
Example 66 /***************************************
**********
67 * FUNCTION: vst_archive_handle
68 *
69 * PURPOSE:
70 * This function tests an archive handle.
71 * PARAMETERS:
72 * none
73 *
74 ****************************************
*********/
75 #ifdef ANSI_C
76 VST_BOOLEAN vst_archive_handle(void)
77 #else
