OffsetClipRgn function

The OffsetClipRgn function moves the clipping region of a device context by the specified offsets.

Syntax


int OffsetClipRgn(
  _In_ HDC hdc,
  _In_ int nXOffset,
  _In_ int nYOffset
);

Parameters

hdc [in]

A handle to the device context.

nXOffset [in]

The number of logical units to move left or right.

nYOffset [in]

The number of logical units to move up or down.

Return value

The return value specifies the new region's complexity and can be one of the following values.

Return codeDescription
NULLREGION

Region is empty.

SIMPLEREGION

Region is a single rectangle.

COMPLEXREGION

Region is more than one rectangle.

ERROR

An error occurred. (The current clipping region is unaffected.)

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Clipping Overview
Clipping Functions
SelectClipRgn

 

 

Show: