IDirectDrawClipper::GetClipList

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectDrawClipper::GetClipListmethod 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.

HRESULT GetClipList(
LPRECT
lpRect
,
LPRGNDATA
lpClipList
,
LPDWORD
lpdwSize
);

Parameters

lpRect

Address of a rectangle that will be used to clip the clip list. This parameter can be NULL to retrieve the entire clip list.

lpClipList

Address of an RGNDATAstructure that will contain the resulting copy of the clip list. If this parameter is NULL, the method fills the variable at lpdwSizeto the number of bytes necessary to hold the entire clip list.

lpdwSize

Size of the resulting clip list. When retrieving the clip list, this parameter is the size of the buffer at lpClipList. When lpClipListis NULL, the variable at lpdwSizereceives the required size of the buffer, in bytes.

Return Values

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

DDERR_GENERIC

DDERR_INVALIDCLIPLIST

Remarks

The RGNDATAstructure used with this method has the following syntax:

typedef struct _RGNDATA { RGNDATAHEADER rdh; char
Buffer[1]; } RGNDATA;

The rdhmember of the RGNDATAstructure is an RGNDATAHEADERstructure 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 Platform SDK.

Requirements

Runs on	Versions	Declared in	Link to
Windows CE OS	2.12 or later. Version 2.12 requires DXPAK 1.0 or later.	ddraw.h	ddraw.lib

See Also

IDirectDrawClipper::SetClipList