PrlEvtPrm_GetBuffer Function

Returns the event parameter value as binary buffer.

Syntax

PRL_RESULT PrlEvtPrm_GetBuffer(
    PRL_HANDLE hEventParam, 
    PRL_VOID_PTR pParamValue, 
    PRL_UINT32_PTR pnParamValueBufLength
);

File

PrlApiCore.h

Parameters

hEventParam

A handle of type PHT_EVENT_PARAMETER identifying the container.

pParamValue

[out] A pointer to a buffer that receives the result.

pnParamValueBufLength

[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_PARAMETER