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.
A version of this page is also available for
4/8/2010

This method sets or deletes the clip list used by the IDirectDrawSurface::Bltand IDirectDrawSurface::UpdateOverlaymethods on surfaces to which the parent DirectDrawClipperobject is attached.

Syntax 

HRESULT SetClipList(
  LPRGNDATA
 lpClipList, 
  DWORD
 dwFlags
);

Parameters

lpClipList

Either an address to a valid RGNDATAstructure or NULL. If there is an existing clip list associated with the DirectDrawClipperobject and this value is NULL, the clip list will be deleted.

dwFlags

This parameter is currently not used and must be set to zero.

Return Value

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_CLIPPERISUSINGHWND

DDERR_INVALIDCLIPLIST

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_OUTOFMEMORY

For more information on these error codes see DirectDraw Return Values.

Remarks

The clip list cannot be set if a window handle is already associated with the DirectDrawClipperobject.

The RGNDATAstructure used with this method has the following syntax.

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

The rdhmember of the RGNDATAstructure is an RGNDATAHEADERstructure that has the following syntax.

Copy Code 
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 Software Development Kit.

Requirements

Header ddraw.h
Library ddraw.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later

See Also