API Guide
601355 Rev A API Functions 2-441
Functions
VS_
Type Capacity
_Destroy
VS_TypeCapacity_Destroy deallocates a type capacity
handle that was allocated by VS_TypeCapacity_Create.
A type capacity handle is used to pass archive type capacity
information from VolServ in response to an Archive Query
command request with the type capacity option specified.
Synopsis VST_BOOLEAN VS_TypeCapacity_Destroy
(VST_TYPECAPACITY_HANDLE handle)
Arguments handle = The type capacity handle to be destroyed.
Return Values VS_TypeCapacity_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 type
capacity handle.
VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
Example 1 /****************************************
*********
2*
3 * FUNCTION: vst_typecapacity_handle
4*
5 * PURPOSE:
6 * This function tests a typecapacity
handle.
7*
8 * PARAMETERS:
9 * none