BdaPropertyGetPinControl function (bdasup.h)

Article
02/22/2024

The BdaPropertyGetPinControl function retrieves either the identifier or type of a pin.

Syntax

NTSTATUS BdaPropertyGetPinControl(
  [in]            PIRP        Irp,
  [in]            PKSPROPERTY Property,
  [out, optional] ULONG       *pulProperty
);

Parameters

[in] Irp

Points to the IRP for the request to retrieve pin information. The BDA minidriver receives this IRP with either the KSPROPERTY_BDA_PIN_ID or KSPROPERTY_BDA_PIN_TYPE request.

[in] Property

Points to a KSPROPERTY structure that describes the property and request type of the property request.

[out, optional] pulProperty

Points to a variable that receives either the identifier or type of a pin.

Return value

Returns STATUS_SUCCESS or an appropriate error code.

Remarks

A BDA minidriver calls the BdaPropertyGetPinControl function to retrieve either the identifier or type of a pin after the minidriver receives either a KSPROPERTY_BDA_PIN_ID or KSPROPERTY_BDA_PIN_TYPE request of the KSPROPSETID_BdaPinControl property set. Most BDA minidrivers can define pin-automation tables so that those minidrivers dispatch the BdaPropertyGetPinControl function directly, without intercepting this request using an internal get-handler (KStrGetPropertyHandler).

Requirements

Requirement	Value
Target Platform	Desktop
Header	bdasup.h (include Bdasup.h)
Library	Bdasup.lib
IRQL	PASSIVE_LEVEL