CBaseReferenceClock::AdviseTime

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Sets up a one-shot notification with the clock.

Syntax

HRESULT AdviseTime(
  REFERENCE_TIME baseTime,
  REFERENCE_TIME streamTime,
  HEVENT hEvent,
  DWORD* pdwAdviseToken
);

Parameters

• baseTime
  Base reference time.

• streamTime
  Stream offset time.

• hEvent
  Advise through this event.

• pdwAdviseToken
  Where the advise token goes.

Return Value

Returns one of the following HRESULT values.

Remarks

This member function implements the IReferenceClock::AdviseTime method.

At the time specified in the baseTime plus the streamTime parameters, the event specified in hEvent is set.

It is correct to call CBaseReferenceClock::Unadvise to remove the link after the event occurs, but it is not necessary. One-shot notifications are cleared by the clock when they have signaled.

To cancel a one-shot notification before the time is reached, call Unadvise and pass the pdwAdviseToken value returned from this call.

Requirements