IDirectMusic::EnumMasterClock

The IDirectMusic::EnumMasterClock method is used to enumerate and get the description of the clocks that DirectMusic can use as the master clock. Each time that it is called, this method retrieves information about a single clock.

HRESULT EnumMasterClock(
  DWORD dwIndex,
  LPDMUS_CLOCKINFO lpClockInfo
);

Parameters

dwIndex

Index of the clock for which the description is to be returned. This parameter should be 0 on the first call, and then incremented in each subsequent call until S_FALSE is returned.

lpClockInfo

Address of a DMUS_CLOCKINFO structure to receive the description of the clock. The application must initialize the dwSize member of this structure before passing the pointer.

Return Values

If the method succeeds, the return value is S_OK, or S_FALSE if there is no clock with that index number.

If it fails, the method can return one of the following error values:

Remarks

Applications should not rely on or store the index number of a clock. Rebooting or adding and removing hardware could cause the index number of a clock to change.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusicc.h.

See Also

IDirectMusic::SetMasterClock, IDirectMusic::GetMasterClock