BdaMethodDeletePin function (bdasup.h)

Article
06/29/2022

The BdaMethodDeletePin function deletes a pin factory.

Syntax

NTSTATUS BdaMethodDeletePin(
  [in] PIRP      pIrp,
  [in] PKSMETHOD pKSMethod,
       PVOID     pvIgnored
);

Parameters

[in] pIrp

Points to the IRP for the request to delete a pin factory. The BDA minidriver receives this IRP with the KSMETHOD_BDA_DELETE_PIN_FACTORY request.

[in] pKSMethod

Points to a KSMETHOD structure that describes the method and request type of a method request.

pvIgnored

Points to a buffer that is ignored.

Return value

Returns STATUS_SUCCESS or an appropriate error code.

Remarks

A BDA minidriver calls the BdaMethodDeletePin function to delete a pin factory after the minidriver receives a KSMETHOD_BDA_DELETE_PIN_FACTORY request of the KSMETHODSETID_BdaDeviceConfiguration method set from the network provider. Most BDA minidrivers can define dispatch and filter-automation tables so that those minidrivers dispatch the BdaMethodDeletePin function directly, without intercepting this request using an internal method (KStrMethodHandler). See Defining Automation Tables and Configuring a BDA Filter for more information.

If a BDA minidriver must delete a pin without relying on the network provider, the BDA minidriver should call the BdaDeletePin function.

Requirements

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