PrlVmCfg_GetAppInDockMode Function

Determines the current dock mode for the specified virtual machine.

Syntax

PRL_RESULT PrlVmCfg_GetAppInDockMode(
    PRL_HANDLE hVmCfg, 
    PRL_APP_IN_DOCK_MODE_PTR pnVmAppInDockMode
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pnVmAppInDockMode

[out] A pointer to a variable that receives the result.

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.