The PHT_EVENT handle is a container that can contain information about system events or extended error information in asynchronous functions.
When the PHT_EVENT object is used as an event data container, a handle to it is obtained through callback functionality (a handle is passed as a parameter to a callback function). When the object is used as an extended error information container in asynchronous functions, a handle to it is obtained from the PHT_JOB object returned by a function by calling the PrlJob_GetError function.
The common steps in processing an event in a callback function are as follows:
|
Name
|
Description
|
|
Determines whether the event is critical or not.
|
|
|
Generates properly formatted and structured answer to a question included in the event.
|
|
|
Generates response to a response included in the event.
|
|
|
Clients can use this method to receive a data buffer specific to the event type.
|
|
|
Returns the code associated with the event.
|
|
|
Returns string representation of the event message.
|
|
|
Returns the event issuer ID (host UUID, virtual machine UUID, etc).
|
|
|
Returns the event issuer type (virtual machine, host, etc.).
|
|
|
Obtains the handle of the job that caused the event.
|
|
|
Obtains a handle of type
PHT_EVENT_PARAMETER
containing an event parameter data.
|
|
|
Obtains a handle of type
PHT_EVENT_PARAMETER
containing an event parameter data by specified parameter name.
|
|
|
Determines the number of the parameters in the event container.
|
|
|
Obtains a handle of type
PHT_SERVER
identifying the Parallels Service that generated the event.
|
|
|
Returns the type of the event.
|
|
|
Obtains a handle of type
PHT_VIRTUAL_MACHINE
referencing the virtual machine that generated the event.
|
|
|
Determines whether the event requires a response from the client.
|