GetBoundsRect function (wingdi.h)

The GetBoundsRect function obtains the current accumulated bounding rectangle for a specified device context.

The system maintains an accumulated bounding rectangle for each application. An application can retrieve and set this rectangle.

Syntax

UINT GetBoundsRect(
  [in]  HDC    hdc,
  [out] LPRECT lprect,
  [in]  UINT   flags
);

Parameters

[in] hdc

A handle to the device context whose bounding rectangle the function will return.

[out] lprect

A pointer to the RECT structure that will receive the current bounding rectangle. The application's rectangle is returned in logical coordinates, and the bounding rectangle is returned in screen coordinates.

[in] flags

Specifies how the GetBoundsRect function will behave. This parameter can be the following value.

Value Meaning
DCB_RESET
Clears the bounding rectangle after returning it. If this flag is not set, the bounding rectangle will not be cleared.

Return value

The return value specifies the state of the accumulated bounding rectangle; it can be one of the following values.

Value Meaning
0 An error occurred. The specified device context handle is invalid.
DCB_DISABLE Boundary accumulation is off.
DCB_ENABLE Boundary accumulation is on.
DCB_RESET The bounding rectangle is empty.
DCB_SET The bounding rectangle is not empty.

Remarks

The DCB_SET value is a combination of the bit values DCB_ACCUMULATE and DCB_RESET. Applications that check the DCB_RESET bit to determine whether the bounding rectangle is empty must also check the DCB_ACCUMULATE bit. The bounding rectangle is empty only if the DCB_RESET bit is 1 and the DCB_ACCUMULATE bit is 0.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header wingdi.h (include Windows.h)
Library Gdi32.lib
DLL Gdi32.dll

See also

Painting and Drawing Functions

Painting and Drawing Overview

SetBoundsRect