API Guide
2-110 API Functions 601355 Rev A
VS_Connect_
Destroy
VS_Connect_Destroy deallocates a connect handle that
was allocated with VS_Connect_Create. A connect handle
is used to pass connect information to and from VolServ.
Synopsis
VST_BOOLEAN VS_Connect_Destroy
(VST_CONNECT_HANDLE handle)
Arguments • handle = Connect handle to be destroyed.
Return Values
VS_Connect_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
command handle.
• VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
Example 1 /****************************************
*********
2*
3 * FUNCTION: vst_connect_handle
4*
5 * PURPOSE:
6 * This function tests a connect handle.
7*
8 * PARAMETERS:
9 * none
10 *
11 ****************************************
*********/