windows_programming_notes.nbk: Home | Index | Next Page: OleLoadPicture | Previous Page: NMITEMACTIVATE

 OffsetRect

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

    BOOL OffsetRect(
      LPRECT lprc,  // rectangle
      int dx,       // horizontal offset
      int dy        // vertical offset
    );

Parameters

• lprc
  [in/out] Pointer to a RECT structure that contains the logical coordinates of the rectangle to be moved.
• dx
  [in] Specifies the amount to move the rectangle left or right. This parameter must be a negative value to move the rectangle to the left.
• dy
  [in] Specifies the amount to move the rectangle up or down. This parameter must be a negative value to move the rectangle up.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Windows NT/2000/XP: To get extended error information, call GetLastError.

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.

Requirements

• Windows NT/2000/XP/Vista: Included in Windows NT 3.1 and later.
• Windows 95/98/Me: Included in Windows 95 and later.
• Header: Declared in Winuser.h; include Windows.h.
• Library: Use User32.lib.

windows_programming_notes.nbk: Home | Index | Next Page: OleLoadPicture | Previous Page: NMITEMACTIVATE

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time