CWBSO_DeleteParmObjHandle

Use the CWBSO_DeleteParmObjHandle API with this product.

Purpose

Deletes a parameter object handle and frees up resources allocated on the client.

Syntax

 
unsigned int CWB_ENTRY CWBSO_DeleteParmObjHandle(
                CWBSO_PARMOBJ_HANDLE parmObjHandle);

Parameters

CWBSO_PARMOBJ_HANDLE parmObjHandle - input: A handle to a parameter object that is returned by a previous call to CWBSO_CreateParmObjHandle.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR: No error occurred.
CWBSO_BAD_PARMOBJ_HANDLE: The parameter object handle that is specified is not valid.

Usage

CWBSO_CreateParmObjHandle must be called prior to calling this API. The parameter object handle that is returned by CWBSO_CreateParmObjHandle must be passed as input to this API.