IDirectMusic8::EnumMasterClock

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusic8::EnumMasterClock

The EnumMasterClock method enumerates the clocks that DirectMusic can use as the master clock. Each time it is called, this method retrieves information about a single clock.

Syntax

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_CLOCKINFO8 structure that receives 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 error values shown in the following table.

Return code
E_INVALIDARG
E_NOINTERFACE
E_POINTER

Remarks

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

Requirements

  Header: Declared in dmusicc.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.