Microsoft Windows CE 3.0  

CBaseReferenceClock::AdviseTime

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Sets up a one-shot notification with the clock.

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 Values

Returns one of the following HRESULTvalues.

E_OUTOFMEMORY  
E_INVALIDARG  
NOERROR No error.

Remarks

This member function implements the IReferenceClock::AdviseTimemethod. At the time specified in the baseTimeplus the streamTimeparameters, the event specified in hEventwill be set. It is correct to call CBaseReferenceClock::Unadviseto remove the link after the event has occurred, but it is not necessary. One-shot notifications are automatically cleared by the clock once they have signaled.

To cancel a one-shot notification before the time is reached, call Unadviseand pass the pdwAdviseTokenvalue returned from this call.