PrlDevDisplay_ConnectToVm Function

Connects to a virtual machine to begin a remote desktop access session.

Syntax

PRL_HANDLE PrlDevDisplay_ConnectToVm(
    PRL_HANDLE hVm, 
    PRL_DISPLAY_CODEC_TYPE type
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

type

Codec type to be used during the remote desktop screen capture.

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

This function must be called before any other function calls related to the remote desktop access functionality.

Links

PrlApi.h , Primary Display Capture