IOverlay::Advise method

The Advise method sets up an advise link for the overlay events specified by the dwInterests parameter.

Syntax


HRESULT Advise(
  [in] IOverlayNotify *pOverlayNotify,
  [in] DWORD          dwInterests
);

Parameters

pOverlayNotify [in]

Pointer to the notification interface.

dwInterests [in]

Callbacks of interest, which can be any subset of the following events.

Event Description
ADVISE_NONENo changes.
ADVISE_CLIPPINGChange in clipping region (synchronized with the window).
ADVISE_PALETTEChange in palette.
ADVISE_COLORKEYChange of chroma key value.
ADVISE_POSITIONChange in position of video window (not synchronized with the window).
ADVISE_DISPLAY_CHANGECalled on WM_DISPLAYCHANGE. The WM_DISPLAYCHANGE message is sent to all windows when the display resolution has changed.
ADVISE_ALL2All of the above.

 

Return value

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

Remarks

This method sets up an advise link for the IOverlayNotify interface to receive notifications. If one of these events occurs, the appropriate entry point in the pOverlayNotify parameter passed in is called (IOverlayNotify::OnClipChange, IOverlayNotify::OnColorKeyChange, IOverlayNotify::OnPaletteChange, or IOverlayNotify::OnPositionChange).

Only one advise link can be set on any given IOverlay interface. Trying to set another notification interface on second and subsequent calls returns VFW_E_ADVISE_ALREADY_SET. You can cancel an advise link by using IOverlay::Unadvise.

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

 

 

Show: