PrlVmCfg_IsShareClipboard Function

Determines whether the clipboard sharing feature is enabled or disabled in a virtual machine.

Syntax

PRL_RESULT PrlVmCfg_IsShareClipboard(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL_PTR pbEnabled
);

File

PrlApi.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pbEnabled

A pointer to a variable that receives the result. PRL_TRUE indicates that the feature is enabled. PRL_FALSE indicates that it is disabled.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer to buffer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

When clipboard sharing is enabled, you can copy and paste text and files from the host to a virtual machine or vise versa, or from one virtual machine to another. This feature requires Parallels Tools installed in a virtual machine.

Links

PrlApi.h , PHT_VM_CONFIGURATION