IDirectMusicPerformance8::Invalidate

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicPerformance8::Invalidate

The Invalidate method flushes all queued messages from the specified time forward and causes all tracks of all segments to resend their data.

Syntax

HRESULT Invalidate(
  MUSIC_TIME mtTime, 
  DWORD dwFlags
);

Parameters

mtTime

Time from which to invalidate, adjusted by dwFlags. Setting this value to 0 causes immediate invalidation.

dwFlags

Flag that aligns mtTime to the next measure, beat, or grid. This value can be 0 or one of the following members of the DMUS_SEGF_FLAGS enumeration:

DMUS_SEGF_MEASURE
DMUS_SEGF_BEAT
DMUS_SEGF_GRID

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return DMUS_E_NO_MASTER_CLOCK.

Remarks

If mtTime is so long ago that it is impossible to invalidate that time, the earliest possible time is used.

Notes that have already been sent to the port are normally cut off by invalidation; that is, any pending note-off message is immediately sent. However, this behavior can be overridden by using one of the DMUS_NOTEF_FLAGS flags in the message structure.

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.