PrlDevDisplay_SendCaptureScreenRequest Function

Sends a request to capture the specified screen region of the specified virtual machine on a periodic basis.

Syntax

PRL_RESULT PrlDevDisplay_SendCaptureScreenRequest(
    PRL_HANDLE hObj, 
    const PRL_IO_SCREEN_REGION_PTR pRect
);

File

PrlApiVm.h

Parameters

hObj

A handle of type PHT_VIRTUAL_MACHINE or PHT_DESKTOP_CONTROL.

pRect

Parameters of the screen region to capture. If negative rectangle is passed, cancellation request will be send.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

The screen data is received as an event via callback every time the specified screen region data is modified. This function is used when an efficient optimization of the screen update on the client side is needed.

Links

Primary Display Capture