Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlUIEmuInput_Create Function
PHT_UIEMU_INPUT

Creates input object.

Syntax
PRL_RESULT PrlUIEmuInput_Create(
    PRL_HANDLE_PTR hInput
);
File

PrlApiVm.h

Parameters

hInput
[out] On success receives handle of type PHT_UIEMU_INPUT.

Returns

PRL_RESULT. Possible values: PRL_ERR_UNINITIALIZED - SDK was not properly initialized. PRL_ERR_INVALID_ARG - hInput is NULL. PRL_ERR_OUT_OF_MEMORY - not enough memory. PRL_ERR_SUCCESS - function completed successfully.

Remarks

To add input to created object call any of PrlUIEmuInput_AddXXX() functions. To send input to guest call PrlVm_UIEmuSendInput() function. Created input object must be explicitly disposed with PrlHandle_Free(). Access to input object is not synchronized. Only one thread at a time can modify it. While one thread modifies input object, other threads can not access it (modify or send it). However, it is safe to send input object from different threads at the same time.

Links
© 2021 Parallels International GmbH. All rights reserved.