cwbSV_GetMessageText

Purpose

Returns the message text portion of the service record object that is identified by the handle that is provided.

Syntax

 
unsigned int CWB_ENTRY cwbSV_GetMessageText(
                             cwbSV_ServiceRecHandle  serviceRecHandle,
                             char                   *messageText,
                             unsigned long           messageTextLength,
                             unsigned long          *returnLength);

Parameters

cwbSV_ServiceRecHandle serviceRecHandle - input

Handle that was returned by a previous call to the cwbSV_CreateServiceRecHandle function.

char * messageText - input/output

Pointer to a buffer that will receive the message text that is stored in the record that is identified by the handle.

unsigned long messageTextLength - input

Length of the receive buffer passed in. If the buffer is too small, the value will be truncated, and CWB_BUFFER_OVERFLOW and returnLength will be set.

unsigned long * returnLength - input/output

Optional, may be NULL. A return address to store the number of bytes needed to hold the output data if the receive buffer is too small.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_BUFFER_OVERFLOW

Output buffer too small, data truncated.

CWB_INVALID_POINTER

NULL passed on output parameter.

CWB_INVALID_HANDLE

Handle is not valid.

CWBSV_INVALID_RECORD_TYPE

Type is not CWBSV_MESSAGE_REC.

Usage

If the record type is not CWBSV_MESSAGE_REC, a return code of CWBSV_INVALID_RECORD_TYPE will be returned. (note: cwbSV_GetServiceType() returns the current record type)