IReferenceClock::AdviseTime method

The AdviseTime method requests an asynchronous notification that a time has elapsed.

Syntax

HRESULT AdviseTime(
  [in]  REFERENCE_TIME rtBaseTime,
  [in]  REFERENCE_TIME rtStreamTime,
  [in]  HEVENT         hEvent,
  [out] DWORD          *pdwAdviseCookie
);

Parameters

rtBaseTime [in]

Base reference time, in 100-nanosecond units.

rtStreamTime [in]

Stream offset time, in 100-nanosecond units.

hEvent [in]

Handle to an event, created by the caller. This event will be signaled when the time specified elapses.

pdwAdviseCookie [out]

Pointer to a variable that receives an identifier for the request. This is used to identify this call to AdviseTime in the future for example, to cancel the request.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.
E_POINTER
The pdwAdviseCookie parameter is NULL.
E_FAIL
Unspecified failure.

See also

IReferenceClock Interface