PrlDevSecondaryDisplay_GetScreenBufferEx Function

Returns the contents of the screen buffer of the secondary display and mapping handle on Windows host (on Unix host hMapping parameter will be always equal to buffer).

Syntax

PRL_RESULT PrlDevSecondaryDisplay_GetScreenBufferEx(
    PRL_HANDLE hObj, 
    PRL_UINT32 display, 
    PRL_UINT32_PTR_PTR buffer, 
    PRL_IO_DISPLAY_SCREEN_SIZE_PTR screenSize, 
    PRL_VOID_PTR_PTR hMapping, 
    PRL_UINT64_PTR mapOffset
);

File

PrlApi.h

Parameters

hObj

A handle of type PHT_VIRTUAL_MACHINE or PHT_DESKTOP_CONTROL .

display

Display ID (0 for primary display, 1, 2, etc.)

buffer

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

screenSize

[out] Screen size.

hMapping

[out] Windows: a handle on screen memory mapping.

mapOffset

[out] Windows: an offset of screen buffer in mapping for specified display. Unix: ignored.

Unix

ignored.

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

PrlApi.h , Secondary Display Capture