PrlEvtPrm_ToBoolean Function

Returns the event parameter value as boolean (PRL_BOOL).

Syntax

PRL_RESULT PrlEvtPrm_ToBoolean(
    PRL_HANDLE hEventParam, 
    PRL_BOOL_PTR pbParamValue
);

PrlApiCore.h

hEventParam

A handle of type PHT_EVENT_PARAMETER identifying the container.

pbParamValue

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

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.