PrlEvent_GetParam Function

Obtains a handle of type PHT_EVENT_PARAMETER containing an event parameter data.

Syntax

PRL_RESULT PrlEvent_GetParam(
    PRL_HANDLE hEvent, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phEventParam
);

File

PrlApi.h

Parameters

hEvent

A handle of type PHT_EVENT identifying the event.

nIndex

An index identifying the event parameter (beginning with 0). To determine the number of the parameters in the event container, use the PrlEvent_GetParamsCount function.

phEventParam

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

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_UNIMPLEMENTED - the event object does not support this functionality.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

An event container may contain multiple parameters. The meaning of the parameter may be different for different event types.

Links

PrlApi.h , PHT_EVENT