cwbSV_LogMessageText

Purpose

This function will log the supplied message text to the currently active history log. The product and component ID's set in the entry will be written along with the date and time of the when the text was logged.

Syntax

 
unsigned int CWB_ENTRY cwbSV_LogMessageText(
                             cwbSV_MessageTextHandle  messageTextHandle,
                             char                    *messageText,
                             unsigned long            messageTextLength);

Parameters

cwbSV_MessageTextHandle messageTextHandle - input

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

char * messageText - input

Points to a buffer that contains the message text you want to log.

unsigned long messageTextLength - input

Specifies the number of bytes in the message text buffer to log for this message entry.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_HANDLE

Unusable handle passed in on request.

Usage

None