Share via

IDirectMusicPerformance::GetSegmentState

  • Article

This method retrieves the currently playing primary segment state or the primary segment state that is playing at a given time.

HRESULT GetSegmentState(
  IDirectMusicSegmentState** ppSegmentState,
  MUSIC_TIME mtTime
);

Parameters

  • ppSegmentState
    Address of a variable to receive a pointer to the segment state. The caller is responsible for calling Release on this pointer.
  • mtTime
    Time for which the segment state is to be retrieved.

Return Values

If the method succeeds, the return value is S_OK.

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

DMUS_E_NOT_FOUND
E_POINTER

Remarks

To get the currently playing segment state, pass the time returned by the IDirectMusicPerformance::GetTime method. The currently playing segment state represents the segment currently generating messages. Because of latency, the currently playing segment state is not necessarily the one being heard.

Requirements

OS Versions: Windows CE .NET 4.0 and Windows CE .NET 4.1.
Header: Dmusici.h.
Link Library: Dmusic.lib.

See Also

IDirectMusicPerformance::GetTime

 Last updated on Monday, April 12, 2004

© 1992-2002 Microsoft Corporation. All rights reserved.