Microsoft DirectX 9.0

IDirectMusic8::Activate

The Activate method activates or deactivates all ports created from this interface.

Syntax

HRESULT Activate(
  BOOL fEnable
);

Parameters

fEnable

Switch to activate (TRUE) or deactivate (FALSE) all port objects created in this instance of DirectMusic.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return DSERR_NODRIVER, indicating that no sound driver is present.

Remarks

Applications should call Activate(FALSE) when they lose input focus if they do not need to play sounds in the background. This allows another application that has the input focus to have access to the ports. When the application has input focus again, it should call Activate(TRUE) to enable all its allocated ports.

Requirements

  Header: Declared in dmusicc.h.

See Also