Export (0) Print
Expand All

IOverlay::GetClipList method

The GetClipList method retrieves the clipping list.

Syntax


HRESULT GetClipList(
  [out]  RECT *pSourceRect,
  [in]   RECT *pDestinationRect,
  [out]  RGNDATA **ppRgnData
);

Parameters

pSourceRect [out]

Pointer to the bounding client rectangle.

pDestinationRect [in]

Pointer to the destination rectangle.

ppRgnData [out]

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]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IOverlay Interface

 

 

Community Additions

ADD
Show:
© 2014 Microsoft