PrlVm_UIEmuSendText Function

Send specified UTF8 text to guest User Input Emulation tool.

Syntax

PRL_RESULT PrlVm_UIEmuSendText(
    PRL_HANDLE hVm, 
    PRL_CONST_STR text, 
    PRL_UINT32 textLength, 
    PRL_UINT32 flags, 
    PRL_UINT32_PTR textSent
);

File

PrlApi.h

Parameters

hVm

[in] Vm handle. Must be valid.

text

[in] text to send. Must be UTF8 encoded. Can't be 0.

textLength

[in] text length. Can be 0 - in that case text must be zero terminated. Use PrlApi_UIEmuSendTextMaxLength() to get maximum text length for specified version.

flags

[in] Flags. Must be 0 now.

textSent

[out] On success receives length of text that was actually sent. Can be 0.

uiEmuVersion

[in] Guest tool version that can be returned by TIS. Can't be 0.

Returns

PRL_RESULT . Possible values: PRL_ERR_UNINITIALIZED - SDK was not properly initialized. PRL_ERR_INVALID_ARG - hVm is invalid, uiEmuVersion or text is 0. PRL_ERR_VM_TOOL_NOT_AVAILABLE - required OS Integration tool not present. PRL_ERR_UNIMPLEMENTED - operation is not supported by current tool version. PRL_ERR_OUT_OF_MEMORY - memory allocation error during send. PRL_ERR_SUCCESS - function completed successfully.

Remarks

This will have the same affect as user typed specified text from keyboard.

Links

PrlApi.h , PHT_VIRTUAL_MACHINE