PrlDevDisplay_ConnectToVm Function

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

Syntax

PRL_HANDLE PrlDevDisplay_ConnectToVm(
    PRL_HANDLE hObj, 
    PRL_DISPLAY_CODEC_TYPE type
);

File

PrlApi.h

Parameters

hObj

A handle of type PHT_VIRTUAL_MACHINE or PHT_DESKTOP_CONTROL .

type

Codec type to be used during the remote desktop screen capture. If server supports display encodings (use # PrlSrv_GetDisplayEncodingList ) your can use encoding type (PRL_IO_DISPLAY_ENCODING.encodingType) instead of PRL_DISPLAY_CODEC_TYPE enum.

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.

Notes

use this call to receive supported server display encodings: PrlSrv_GetDisplayEncodingList also you can receive or change display encoding at runtime: PrlDevDisplay_SetDisplayEncoding PrlDevDisplay_GetDisplayEncoding

Links

PrlApi.h , Primary Display Capture