CWBSO_DeleteObjHandle

Purpose

Deletes an object handle returned from a previous call to CWBSO_GetObjHandle or CWBSO_CopyObjHandle.

Syntax

 
unsigned int CWB_ENTRY CWBSO_DeleteObjHandle(
                CWBSO_OBJ_HANDLE objectHandle);         

Parameters

CWBSO_OBJ_HANDLE objectHandle - input

A handle to an object that is returned by a previous call to CWBSO_GetObjHandle or CWBSO_CopyObjHandle.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR

No error occurred.

CWBSO_BAD_OBJ_HANDLE

The object handle that is specified is not valid.

Usage

CWBSO_GetObjHandle or CWBSO_CopyObjHandle must be called prior to calling this API. The object handle that is returned by CWBSO_GetObjHandle or CWBSO_CopyObjHandle must be passed as input to this API.