PrlVm_UIEmuQueryCaretInfo Function

Posts "get caret info" query to guest User Input Emulation tool.

Syntax

PRL_RESULT PrlVm_UIEmuQueryCaretInfo(
    PRL_HANDLE hVm, 
    PRL_INT32 queryId, 
    PRL_UINT32 queryFlags
);

File

PrlApiVm.h

Parameters

hVm

[in] Handle of type PHT_VIRTUAL_MACHINE. Must be valid.

queryId

[in] user-defined value that will be in response.

quertFlags

[in] additional options.

Returns

PRL_RESULT. Possible values: PRL_ERR_UNINITIALIZED - SDK was not properly initialized. PRL_ERR_INVALID_ARG - specified arguments are invalid. PRL_ERR_OUT_OF_MEMORY - memory allocation error during send. PRL_ERR_SUCCESS - function completed successfully.

Remarks

Response will be received via PET_IO_UIEMU_CARET_INFO event with PRL_UIEMU_CARET_INFO structure on board. Note, that guest tool will not always reply with PET_IO_UIEMU_CARET_INFO event. It will reply only when it got some information on caret. Since not all versions of User Input Emulation tool support this request and not all guest OS can supply required functionality, use TIS uuid "parallels.UserInputEmulation.guest.cross.plugin.CaretInfo" to get status of that feature. If this uuid is in active state in TIS database, this function can be used.

Links

PHT_VIRTUAL_MACHINE