IDirectMusicAudioPath8::Activate

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicAudioPath8::Activate

The Activate method activates or deactivates the audiopath.

Syntax

HRESULT Activate(
  BOOL fActivate
);

Parameters

fActivate

Boolean that specifies whether to activate (TRUE) or deactivate (FALSE) the audiopath.

Return Values

If the method succeeds, the return value is S_OK, or S_FALSE if the audiopath is already in the requested state.

Remarks

The behavior of this method is different from that of IDirectMusicPort8::Activate. When a port is deactivated, it no longer produces sound, but the performance can continue playing segments. When an audiopath is deactivated, all playback stops and any attempt to play a segment will fail.

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.