IOverlay::GetClipList method (strmif.h)

The GetClipList method retrieves the clipping list.

Syntax

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

Parameters

pSourceRect

Pointer to the bounding client rectangle.

pDestinationRect

Pointer to the destination rectangle.

ppRgnData

Address of a pointer to the header and data describing clipping. If successful, free the allocated memory by calling CoTaskMemFree.

Return value

Returns S_OK if successful. If the method fails, it returns an HRESULT error code.

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

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IOverlay Interface