IPinName::GetPinName method (portcls.h)
The GetPinName method retrieves the friendly name of an audio endpoint. For more information about Pins, see Filter, Pin, and Node Properties.
Syntax
NTSTATUS GetPinName(
[in] PIRP Irp,
[in] PKSP_PIN Pin,
[out] PVOID Data
);
Parameters
[in] Irp
Specifies a pointer to an I/O request packet (IRP) structure. For more information about IRPs, see IRP and I/O request packets.
[in] Pin
Specifies a pointer to the underlying kernel streaming (KS) pin.
[out] Data
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.
For more information about
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
| Requirement | Value |
|---|---|
| Minimum supported client | Available in Windows 7 and later versions of Windows. |
| Target Platform | Universal |
| Header | portcls.h (include Portcls.h) |
| IRQL | PASSIVE_LEVEL. |
See also
Friendly Names for Audio Endpoint Devices