PrlEvent_GetErrString Function

Returns string representation of the event message.

Syntax

PRL_RESULT PrlEvent_GetErrString(
    PRL_HANDLE hEvent, 
    PRL_BOOL bIsBriefMessage, 
    PRL_BOOL bFormated, 
    PRL_STR sErrString, 
    PRL_UINT32_PTR pnErrStringBufLength
);

File

PrlApiCore.h

Parameters

hEvent

A handle of type PHT_EVENT identifying the event.

bIsBriefMessage

Specifies whether to return a brief or a long version of the message. Specify PBL_TRUE to return a brief message. Specify PRL_FALSE to return a long message.

bFormated

Specifies whether the HTML tags used for text formatting should be included in the resulting string. PRL_TRUE - include HTML tags. PRL_FALSE - don't include.

sErrString

[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).

pnErrStringBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

Returns

PRL_RESULT. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter that is used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_EVENT