Edit

Share via

IRDPSRAPIFrameBuffer::GetFrameBufferBits method (rdpencomapi.h)

  • Article

Gets the bits in a specified area of the frame.

Syntax

HRESULT GetFrameBufferBits(
  [in]          long      x,
  [in]          long      y,
  [in]          long      Width,
                long      Heigth,
  [out, retval] SAFEARRAY **ppBits
);

Parameters

[in] x

The x coordinate of the requested area of the frame.

[in] y

The y coordinate of the requested area of the frame.

[in] Width

The width of the requested area of the frame.

Heigth

[out, retval] ppBits

The contents of the frame buffer in the specified area.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

Requirements

Requirement Value
Minimum supported client Windows 10 [desktop apps only]
Minimum supported server Windows Server 2016
Target Platform Windows
Header rdpencomapi.h
DLL RdpEncom.dll

See also

IRDPSRAPIFrameBuffer