cwbSV_CreateErrHandle

Purpose

This function creates an error message object and returns a handle to it. This error handle can be passed to @@xe1s@@ APIs that support it. If an error occurs on one of these APIs, the error handle can be used to retrieve the error messages text that is associated with the API error.

Syntax

 
unsigned int CWB_ENTRY cwbSV_CreateErrHandle(
                             cwbSV_ErrHandle *errorHandle);

Parameters

cwbSV_ErrHandle *errorHandle - input/output

Pointer to a cwbSV_ErrHandle where the handle will be returned.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_POINTER

NULL passed as handle address.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory to create handle.

Usage

None