IConnector::GetDeviceIdConnectedTo method

The GetDeviceIdConnectedTo method gets the device identifier of the audio device, if any, that this connector is connected to.

Syntax


HRESULT GetDeviceIdConnectedTo(
  [out] LPWSTR *ppwstrDeviceId
);

Parameters

ppwstrDeviceId [out]

Pointer to a string pointer into which the method writes the address of a null-terminated, wide-character string that contains the device identifier of the connected device. The method allocates the storage for the string. The caller is responsible for freeing the storage, when it is no longer needed, by calling the CoTaskMemFree function. If the GetDeviceIdConnectedTo call fails, *ppwstrDeviceId is NULL. For information about CoTaskMemFree, see the Windows SDK documentation.

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 codeDescription
E_POINTER

Pointer ppwstrDeviceId is NULL.

E_NOTFOUND

This connector is not connected, or the other side of the connection is not another device topology (for example, a Software_IO connection).

E_MEMORY

Out of memory.

 

Remarks

The device identifier obtained from this method can be used as an input parameter to the IMMDeviceEnumerator::GetDevice method.

This method is functionally equivalent to, but more efficient than, the following series of method calls:

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Devicetopology.h

See also

IConnector Interface
IMMDeviceEnumerator::GetDevice

 

 

Show: