PrlDevDisplay_SyncCaptureScaledScreenRegionToBuffer Function

Captures a screen area of a remote virtual machine desktop, scales is down to the specified size, and puts it into a buffer which is then returned to the client.

Syntax

PRL_RESULT PrlDevDisplay_SyncCaptureScaledScreenRegionToBuffer(
    PRL_HANDLE hVm, 
    PRL_VOID_PTR_PTR buff, 
    PRL_UINT32_PTR buffSize, 
    PRL_IMAGE_FORMAT format, 
    PRL_INT32 quality, 
    PRL_UINT32 x, 
    PRL_UINT32 y, 
    PRL_UINT32 width, 
    PRL_UINT32 height, 
    PRL_UINT32 scaleWidth, 
    PRL_UINT32 scaleHeight
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

buff

[out] A pointer to a buffer containing the screen data. The buffer must be freed with PrlBuffer_Free when no longer needed.

buffSize

The size of the buffer received in the buff parameter (above).

format

Image format to use.

quality

Image quality factor. Must be in the range from 0 to 100, or -1. Specify 0 to use the highest data compression, 100 for no compression, and -1 for default.

The X coordinate of the upper-left corner of the screen area to capture.

The Y coordinate of the upper-left corner of the screen area to capture.

width

The width of the screen area to capture, in pixels.

height

The height of the area to capture, in pixels.

scaleWidth

The width of the scaled down image, in pixels.

scaleHeight

The height of the scaled down image, in pixels.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

For local connections, the capture works almost instantly. For remote connections, the data must be transferred over network to the client machine, so it may take some time. This synchronous function is an equivalent of the asynchronous function PrlDevDisplay_AsyncCaptureScaledScreenRegionToBuffer . You can use either function in your programs depending on your application needs.