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 function creates an instance of a DirectDrawClipper object not associated with a DirectDraw object.

Syntax 

HRESULT WINAPI DirectDrawCreateClipper(
  DWORD
 dwFlags, 
  LPDIRECTDRAWCLIPPER FAR* 
lplpDDClipper, 
  IUnknown FAR* 
pUnkOuter
);

Parameters

dwFlags

[in] Currently not used; set to zero.

lplpDDClipper

[out] Address of a pointer that will be filled with the address of the new DirectDrawClipper object.

pUnkOuter

[in] Allows for future compatibility with COM aggregation functionality.

This method returns CLASS_E_NOAGGREGATION if this parameter is anything but NULL.

Return Value

If the function succeeds, the return value is DD_OK.

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

Remarks

This function can be called before any DirectDraw objects are created.

Because these DirectDrawClipper objects are not owned by any DirectDraw object, they are not released when an application's objects are released. If the application does not explicitly release the DirectDrawClipper objects, DirectDraw releases them when the application terminates.

To create a DirectDrawClipper object owned by a specific DirectDraw object, use the IDirectDraw::CreateClippermethod.

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