CWBSO_CreateErrorHandle

Purpose

Creates an error handle. An error handle is used to contain error messages that are returned from other APIs. The error handle may be used to display the error in a dialog or retrieve the associated error message text.

Syntax

 
unsigned int CWB_ENTRY CWBSO_CreateErrorHandle(
                CWBSO_ERR_HANDLE far* lpErrorHandle);   

Parameters

CWBSO_ERR_HANDLE far* lpErrorHandle - output

A long pointer to a handle which will be set to the handle for an error.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR

No error occurred.

CWBSO_LOW_MEMORY

Not enough memory is available for the request.

Usage

When the error handle is no longer needed, the calling program is responsible for doing the following:

• Call CWBSO_DeleteErrorHandle to free up resources that are allocated on the client.