PrlEvtPrm_ToHandle Function

Returns the event parameter value as PRL_HANDLE.

Syntax

PRL_RESULT PrlEvtPrm_ToHandle(
    PRL_HANDLE hEventParam, 
    PRL_HANDLE_PTR phParamValue
);

hEventParam

A handle of type PHT_EVENT_PARAMETER identifying the container.

phParamValue

[out] A pointer to a variable that receives the handle. The handle type can be determined using the PrlHandle_GetType function.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.