Microsoft DirectX 9.0


The GetClipList method returns a copy of the clip list associated with a DirectDrawClipper object. A subset of the clip list can be selected by passing a rectangle which will be used to clip the clip list.


HRESULT GetClipList(
  LPRECT lpRect,
  LPRGNDATA lpClipList,
  LPDWORD lpdwSize 



Points to a rectangle that will be used to clip the clip list.


Points to a RGNDATA structure which will contain the resulting copy of the clip list.


Set by GetClipList to indicate the size of the resulting clip list.

Return Values

Value Description
DD_OK The method succeeded.
DDERR_INVALIDOBJECT DirectDraw received a pointer that was an invalid DirectDraw object.
DDERR_INVALIDPARAMS One or more of the parameters passed to the function are incorrect.
DDERR_INVALIDCLIPLIST DirectDraw does not support the provided clip list.
DDERR_NOCLIPLIST No clip list available.
DDERR_REGIONTOOSMALL Region passed to GetClipList is too small.
DDERR_GENERIC Generic failure.

See Also