PrlVm_StartVncServer Function

Starts a VNC server for the specified virtual machine.

Syntax

PRL_HANDLE PrlVm_StartVncServer(
    PRL_HANDLE hVm, 
    PRL_UINT32 nReserved
);

File

PrlApiVm.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

nReserved

Reserved parameter for future purposes. Must contain 0 in the current implementation.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer for user name was passed.

PRL_ERR_SUCCESS - function completed successfully.