PHT_EVENT_PARAMETER

The PHT_EVENT_PARAMETER handle is a container that contains system event parameter data. The handle is obtained by calling the PrlEvent_GetParam function.

Description

The event parameter container contains the following information:

Parameter name. To retrieve the name, use the PrlEvtPrm_GetName function.
Parameter data type. Depending on the event type, a parameter can be of any type defined in the PRL_PARAM_FIELD_DATA_TYPE_PTR enumeration. To retrieve the parameter data type, use the PrlEvtPrm_GetType function.
Parameter value. Depending on the parameter data type, the value must be retrieved using an appropriate function from the PHT_EVENT_PARAMETER group (see the function list below). For example, a boolean value must be retrieved using the PrlEvtPrm_ToBoolean function, the string value must be retrieved using the PrlEvtPrm_ToString function, if a parameter contains a handle, it must be obtained using the PrlEvtPrm_ToHandle, etc. The meaning of the value is usually different for different event types.

Functions

	Name	Description
	PrlEvtPrm_GetBuffer	Returns the event parameter value as binary buffer.
	PrlEvtPrm_GetName	Returns the event parameter name.
	PrlEvtPrm_GetType	Returns the event parameter data type.
	PrlEvtPrm_ToBoolean	Returns the event parameter value as boolean (PRL_BOOL).
	PrlEvtPrm_ToCData	Returns the event parameter value as CDATA.
	PrlEvtPrm_ToHandle	Returns the event parameter value as PRL_HANDLE.
	PrlEvtPrm_ToInt32	Returns the event parameter value as PRL_INT32.
	PrlEvtPrm_ToInt64	Returns the event parameter value as PRL_INT64.
	PrlEvtPrm_ToString	Returns the event parameter value as string.
	PrlEvtPrm_ToUint32	Returns the event parameter value as PRL_UINT32.
	PrlEvtPrm_ToUint64	Returns the event parameter value as PRL_UINT64.

Links

Functions, Functions by Handle, Legend