IAudioMute::SetMute method (devicetopology.h)

  • Article

The SetMute method enables or disables the mute control.

Syntax

HRESULT SetMute(
  [in] BOOL    bMuted,
  [in] LPCGUID pguidEventContext
);

Parameters

[in] bMuted

The new muting state. If bMuted is TRUE (nonzero), the method enables muting. If FALSE, the method disables muting.

[in] pguidEventContext

Context value for the IControlChangeNotify::OnNotify method. This parameter points to an event-context GUID. If the SetMute call changes the state of the mute control, all clients that have registered IControlChangeNotify interfaces with that control receive notifications. In its implementation of the OnNotify method, a client can inspect the event-context GUID to discover whether it or another client is the source of the control-change event. If the caller supplies a NULL pointer for this parameter, the client's notification method receives a NULL context pointer.

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
E_OUTOFMEMORY
 Out of memory.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header devicetopology.h

See also

IAudioMute Interface