PrlVmCfg_SetExcludeDock Function

Sets the exclude dock option.

Syntax

PRL_RESULT PrlVmCfg_SetExcludeDock(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bVmExcludeDock
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

bVmExcludeDock

The value to set. Specify PRL_TRUE to exclude the dock. Specify PRL_FALSE to include the dock.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

When a virtual machine is running in coherence mode, you can make the dock stay always below the virtual machine window. If the window is moved below the dock, the portion of it that crossed that boundary will be cut (will not be redrawn). In order to do that, call this function passing PRL_TRUE in the bVmExcludeDock parameter. If the parameter is set to PRL_FALSE, the virtual machine window will be able to move below the dock.

Parallels Tools must be installed to use this feature. To obtain the Parallels Tools status, use the PrlVm_GetToolsState function.

Links

PHT_VM_CONFIGURATION