OffsetRect function (winuser.h)

Article
02/22/2024

The OffsetRect function moves the specified rectangle by the specified offsets.

Syntax

BOOL OffsetRect(
  [in, out] LPRECT lprc,
  [in]      int    dx,
  [in]      int    dy
);

Parameters

[in, out] lprc

Pointer to a RECT structure that contains the logical coordinates of the rectangle to be moved.

[in] dx

Specifies the amount to move the rectangle left or right. This parameter must be a negative value to move the rectangle to the left.

[in] dy

Specifies the amount to move the rectangle up or down. This parameter must be a negative value to move the rectangle up.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

Because applications can use rectangles for different purposes, the rectangle functions do not use an explicit unit of measure. Instead, all rectangle coordinates and dimensions are given in signed, logical values. The mapping mode and the function in which the rectangle is used determine the units of measure.

Examples

For an example, see Using Rectangles.

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	winuser.h (include Windows.h)
Library	User32.lib
DLL	User32.dll

Share via