PrlDevDisplay_GetScreenBuffer Function

Returns the contents of the screen buffer of the primary display.

Syntax

PRL_RESULT PrlDevDisplay_GetScreenBuffer(
    PRL_HANDLE hObj, 
    PRL_UINT32_PTR_PTR buffer, 
    PRL_INT32_PTR lineSize
);

File

PrlApiVm.h

Parameters

hObj

A handle of type PHT_VIRTUAL_MACHINE or PHT_DESKTOP_CONTROL.

buffer

[out] A pointer to a buffer that receives the data. The screen data is always returned as 32-bit RGBA with the alpha channel containing the value of 0.

lineSize

Line size.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Please note that the primary screen buffer can be refreshed at any time from inside the virtual machine. To prevent incomplete or corrupt data, use the PrlDevDisplay_LockForRead function to temporarily suspend refreshing of the screen on the virtual machine side. The screen data is always returned as 32-bit RGBA with the alpha channel containing the value of 0.

Links

Primary Display Capture