PrlVmCfg_SetAppInDockMode Function

Sets the dock mode for the applications (see PRL_APP_IN_DOCK_MODE for available options).

Syntax

PRL_RESULT PrlVmCfg_SetAppInDockMode(
    PRL_HANDLE hVmCfg, 
    PRL_APP_IN_DOCK_MODE nVmAppInDockMode
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nVmAppInDockMode

The applications in dock mode option to set. See the PRL_APP_IN_DOCK_MODE enumeration for the list of options.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

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