Edit

IAudioInputSelector::SetSelection method (devicetopology.h)

  • Article

The SetSelection method selects one of the inputs of the input selector.

Syntax

HRESULT SetSelection(
  [in] UINT    nIdSelect,
  [in] LPCGUID pguidEventContext
);

Parameters

[in] nIdSelect

The new selector input. The caller should set this parameter to the local ID of a part that has a direct link to one of the selector inputs.

[in] pguidEventContext

Context value for the IControlChangeNotify::OnNotify method. This parameter points to an event-context GUID. If the SetSelection call changes the state of the input-selector 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_INVALIDARG
 Parameter nIdSelect is not the local ID of a part at a selector input.
E_OUTOFMEMORY
 Out of memory.

Remarks

A local ID is a number that uniquely identifies a part among all parts in a device topology. To obtain the local ID of a part, call the IPart::GetLocalId method on the part object.

For a code example that calls the SetSelection method, see the implementation of the SelectCaptureDevice function in Device Topologies.

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

IAudioInputSelector Interface

IPart::GetLocalId