IReferenceClock::AdviseTime

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IReferenceClock::AdviseTime

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

Syntax

HRESULT AdviseTime(
  REFERENCE_TIME baseTime,
  REFERENCE_TIME streamTime,
  HANDLE hEvent,
  DWORD * pdwAdviseCookie
);

Parameters

baseTime

Base reference time.

streamTime

Stream offset time.

hEvent

Handle to an event through which to advise.

pdwAdviseCookie

Address of a variable that receives the identifier of the request. This is used to identify this call to AdviseTime in the future—for example, to cancel it.

Return Values

Return values are determined by the implementation. If the method succeeds, it returns S_OK.

If it fails, the method can return one of the error values shown in the following table.

Return code
E_FAIL
E_POINTER
E_INVALIDARG
E_NOTIMPL

Remarks

When the time baseTime plus streamTime is reached, the event whose handle is hEvent is set. If the time has already passed, the event is set immediately.

Requirements

  Header: Declared in dmusicc.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.