Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PHT_EVENT_PARAMETER
Functions  Functions by Handle  Legend

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:

  1. Parameter name. To retrieve the name, use the PrlEvtPrm_GetName function.
  2. 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.
  3. 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 
 
Returns the event parameter value as binary buffer. 
 
Returns the event parameter name. 
 
Returns the event parameter data type. 
 
Returns the event parameter value as boolean (PRL_BOOL). 
 
Returns the event parameter value as CDATA. 
 
Returns the event parameter value as PRL_HANDLE
 
Returns the event parameter value as PRL_INT32
 
Returns the event parameter value as PRL_INT64
 
Returns the event parameter value as string. 
 
Returns the event parameter value as PRL_UINT32
 
Returns the event parameter value as PRL_UINT64
Links
© 2021 Parallels International GmbH. All rights reserved.