Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlEvent_GetParamByName Function
PHT_EVENT

Obtains a handle of type PHT_EVENT_PARAMETER containing an event parameter data by specified parameter name.

Syntax
PRL_RESULT PrlEvent_GetParamByName(
    PRL_HANDLE hEvent, 
    PRL_CONST_STR sParamName, 
    PRL_HANDLE_PTR phEventParam
);
File

PrlApiCore.h

Parameters

hEvent
A handle of type PHT_EVENT identifying the event.
sParamName
Event parameter name.
phEventParam
[out] A pointer to a variable that receives the handle.

Returns

PRL_RESULT. Possible values: 

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. 

PRL_ERR_UNIMPLEMENTED - the event object does not support this functionality. 

PRL_ERR_NO_DATA - parameter with specfied name does not exist. 

PRL_ERR_SUCCESS - function completed successfully. 

Remarks

An event container may contain multiple parameters. The meaning of the parameter may be different for different event types.

Links
© 2021 Parallels International GmbH. All rights reserved.