CWBSO_DisplayErrMsg

Purpose

Displays an error message in a dialog box. This API should only be called when CWBSO_ERROR_OCCURRED is the return value from a call to another API. In this case, there is an error message that is associated with the error handle.

Syntax

 
unsigned int CWB_ENTRY CWBSO_DisplayErrMsg(
                CWBSO_ERR_HANDLE errorHandle);          

Parameters

CWBSO_ERR_HANDLE errorHandle - input

A handle to an error.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR

No error occurred.

CWBSO_BAD_ERR_HANDLE

The error handle that is specified is not valid.

CWBSO_NO_ERROR_MESSAGE

The error handle that is specified contains no error message.

CWBSO_DISP_MSG_FAILED

The request to display the message failed.

Usage

CWBSO_CreateErrorHandle must be called prior to calling this API. The error handle that is returned by CWBSO_CreateErrorHandle must be passed as input to this API.