IPinName::GetPinName method

The GetPinName method retrieves the friendly name of an audio endpoint.

Syntax


NTSTATUS GetPinName(
  [in]   PIRP Irp,
  [in]   PKSP_PIN Pin,
  [out]  PVOID Data
);

Parameters

Irp [in]

Specifies a pointer to an I/O request packet (IRP) structure.

Pin [in]

Specifies a pointer to the underlying kernel streaming (KS) pin.

Data [out]

Specifies a pointer to the buffer that holds the data for the GetPinName method.

Return value

The GetPinName method returns STATUS_SUCCESS if the call was successful. Otherwise, it returns an appropriate error code.

Remarks

If a client needs the current pin name of an endpoint, but has determined that the miniport driver does not support the GetPinName method, the client uses the friendly name of the topology bridge pin. For more information about pin categories and friendly names, see Pin Category Property and Friendly Names for Audio Endpoint Devices.

Note   In Windows 7, the user-mode audio stack does not support customization of the Speakers endpoint name. So in Windows 7, the GetPinName method only works with endpoints that do not have the Speakers friendly name. The following list shows the KS node type categories that are assigned the Speakers friendly name:

KSNODETYPE_SPEAKER

KSNODETYPE_DESKTOP_SPEAKER

KSNODETYPE_ROOM_SPEAKER

KSNODETYPE_LOW_FREQUENCY_EFFECTS_SPEAKER

Requirements

Version

Available in Windows 7 and later versions of Windows.

Header

Portcls.h (include Portcls.h)

IRQL

PASSIVE_LEVEL.

See also

Friendly Names for Audio Endpoint Devices
Pin Category Property

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.