PrlEvent_GetVm Function

Obtains a handle of type PHT_VIRTUAL_MACHINE referencing the virtual machine that generated the event.

Syntax

PRL_RESULT PrlEvent_GetVm(
    PRL_HANDLE hEvent, 
    PRL_HANDLE_PTR pVm
);

hEvent

A handle of type PHT_EVENT identifying the event.

pVm

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

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

When processing an event inside a callback function (event handler) this function is the only way to get the virtual machine handle.