cwbSV_SetMessageClass

Purpose

This function allows setting of the message class (severity) to associate with the message being written to the history log.

Syntax

unsigned int CWB_ENTRY cwbSV_SetMessageClass(
                             cwbSV_MessageTextHandle  messageTextHandle,
                             cwbSV_MessageClass       messageClass);

Parameters

cwbSV_MessageTextHandle messageTextHandle - input

Handle that was returned by a previous call to cwbSV_CreateMessageTextHandle().

cwbSV_MessageClass messageClass - input

One of the following:

• CWBSV_CLASS_INFORMATIONAL
• CWBSV_CLASS_WARNING
• CWBSV_CLASS_ERROR

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_HANDLE

Unusable handle passed in on request.

CWBSV_INVALID_MSG_CLASS

Invalid message class passed in.

Usage

This value should be set before calling the corresponding log function, "cwbSV_LogMessageText()".