PrlDevDisplay_ConnectToVmEx Function

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

Syntax

PRL_HANDLE PrlDevDisplay_ConnectToVmEx(
    PRL_HANDLE hObj, 
    const PRL_IO_DISPLAY_ENCODING_PTR pEnc, 
    PRL_DISPLAY_BUFFER_FORMAT format
);

File

PrlApi.h

Parameters

hObj

A handle of type PHT_VIRTUAL_MACHINE or PHT_DESKTOP_CONTROL .

pEnc

Codec type to be used during the remote desktop screen capture. If server supports display encodings (use # PrlSrv_GetDisplayEncodingList ) your can use pointer to encoder.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object PRL_ERR_DISPLAY_FORMAT_NOT_SUPPORTED if specified format is not supported

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 format : Conversion format of inner display screen buffer. If conversion format is not supported by SDK error will be returned

Links

PrlApi.h , Primary Display Capture