IDirectDrawClipper::GetClipList

HRESULT GetClipList(LPRECT lpRect, LPRGNDATA lpClipList,

LPDWORD lpdwSize);

Retrieves a copy of the clip list associated with a DirectDrawClipper object. A subset of the clip list can be selected by passing a rectangle that clips the clip list.

·Returns DD_OK if successful, or one of the following error values otherwise:

DDERR_GENERIC

DDERR_INVALIDCLIPLIST

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_NOCLIPLIST

DDERR_REGIONTOOSMALL

lpRect

Address of a rectangle that will be used to clip the clip list.

lpClipList

Address of an RGNDATA structure that will contain the resulting copy of the clip list.

lpdwSize

Size of the resulting clip list.

The RGNDATA structure used with this method has the following syntax.

typedef struct _RGNDATA {

RGNDATAHEADER rdh;

char Buffer[1];

} RGNDATA;

The rdh member of the RGNDATA structure is an RGNDATAHEADER structure that has the following syntax.

typedef struct _RGNDATAHEADER {

DWORD dwSize;

DWORD iType;

DWORD nCount;

DWORD nRgnSize;

RECT rcBound;

} RGNDATAHEADER;

For more information about these structures, see the documentation in the Win32 Software Development Kit.