PrlVmCfg_SetShareClipboard Function

Enables or disables the clipboard sharing feature.

Syntax

PRL_RESULT PrlVmCfg_SetShareClipboard(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bEnabled
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

bEnabled

Action type. Set to PRL_TRUE to enabled clipboard sharing. Set to PRL_FALSE to disable it.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle 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

PHT_VM_CONFIGURATION