PrlHandle_GetPackageId Function

Returns the numeric identifier of the package that caused the event.

Syntax

PRL_RESULT PrlHandle_GetPackageId(
    PRL_HANDLE hObj, 
    PRL_UINT64_PTR id
);

File

PrlApiCore.h

Parameters

[out] A pointer to a variable that receives the result (event id).

hEvent

A handle of type PHT_EVENT or PHT_JOB.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

The numeric identifier is a monotonically increasing number. It is reset to one on dispatcher restart. If event or job was not originated in the dispatcher, then the numeric identifier is equal to zero. A triplet of values forms a unique monotonically increasing numeric identifier that could be used for event ordering. See PrlSrvInfo_GetStartTime and PrlSrvInfo_GetStartTimeMonotonic for details on how to obtain (monotonic) dispatcher start time value.