PrlVmCfg_GetVNCMode Function

Returns the VNC mode of the specified virtual machine.

Syntax

PRL_RESULT PrlVmCfg_GetVNCMode(
    PRL_HANDLE hVmCfg, 
    PRL_VM_REMOTE_DISPLAY_MODE_PTR pnVmRemoteDisplayMode
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pnVmRemoteDisplayMode

[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.