cwbSV_DeleteMessageTextHandle

Use the cwbSV_DeleteMessageTextHandle API with this product.

Purpose

This function deletes the message text object that is identified by the handle that is provided.

Syntax

 
unsigned int CWB_ENTRY cwbSV_DeleteMessageTextHandle(
                             cwbSV_MessageTextHandle messageTextHandle);

Parameters

cwbSV_MessageTextHandle messageTextHandle - input: Handle that was returned by a previous call to the cwbSV_CreateMessageTextHandle() function.

Return Codes

The following list shows common return values.

CWB_OK: Successful completion.
CWB_INVALID_HANDLE: Unusable handle passed in on request.

Usage

This call should be made when the handle is no longer needed.