ADIC 601355 Rev A VS

API Guide

601355 Rev A API Functions 2-435

Functions

VS_Terminate VS_Terminate terminates the VolServ API software.

VS_Terminate releases all memory allocated by the API and

deregisters and frees all RPC transports.

Synopsis VST_BOOLEAN VS_Terminate (void)

Arguments None

Return Values VS_Terminate returns:

•VSE_TRUE - Successful execution.

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

in VSG_Error.

•VSE_ERR_NOTINITIALIZED - The VolServ API is not

initialized.

•VSE_ERR_SYSTEMCALL - A system call failed (usually

from RPC). This generic error code covers an error that

stems from a system call. The API sets this when

encountering a failure during RPC setup.

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

*********

3 * FUNCTION: vst_terminate

5 * PURPOSE:

6 * This function shuts down the VolServ

API.

8 * PARAMETERS:

9 * none

10 *