Share via


IOverlay::GetClipList

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves the clipping list.

Syntax

HRESULT GetClipList(
  RECT* pSourceRect,
  RECT* pDestinationRect,
  RGNDATA** ppRgnData
);

Parameters

  • pSourceRect
    [out] A pointer to a RECT structure that describes the bounding client rectangle.
  • pDestinationRect
    [in] A pointer to a RECT structure that describes the destination rectangle.
  • ppRgnData
    [out] A pointer to a RGNDATA pointer that contains the header and data that describes clipping. If successful, the Win32 CoTaskMemFree function should free memory.

Return Value

None.

Remarks

The IOverlay implementation allocates the memory for the clipping rectangles, because it can vary in length. The filter calling this method should free the memory (using CoTaskMemFree) when it is finished with it.

Requirements

Windows Embedded CE Windows CE 2.12 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment, Version 2.12 requires DXPAK 1.0 or later

See Also

Reference

IOverlay Interface