BdaPropertyGetControllingPinId function (bdasup.h)

The BdaPropertyGetControllingPinId function retrieves the identifier of a pin on which to control the properties, methods, and events of a specific node.

Syntax

NTSTATUS BdaPropertyGetControllingPinId(
  [in]            PIRP              Irp,
  [in]            PKSP_BDA_NODE_PIN Property,
  [out, optional] PULONG            pulControllingPinId
);

Parameters

[in] Irp

Points to the IRP for the request to retrieve the controlling pin for a node. The BDA minidriver receives this IRP with the KSPROPERTY_BDA_CONTROLLING_PIN_ID request.

[in] Property

Points to a KSP_BDA_NODE_PIN structure that describes the property and request type of the property request to retrieve the controlling pin for a node.

[out, optional] pulControllingPinId

Points to a variable that receives the identifier of the controlling pin for a node.

Return value

Returns STATUS_SUCCESS or an appropriate error code.

Remarks

A BDA minidriver calls the BdaPropertyGetControllingPinId function to retrieve the identifier of the controlling pin for a node after the minidriver receives a KSPROPERTY_BDA_CONTROLLING_PIN_ID request of the KSPROPSETID_BdaTopology property set from the network provider. Most BDA minidrivers can define dispatch and filter-automation tables so that those minidrivers dispatch the BdaPropertyGetControllingPinId function directly, without intercepting this request using an internal get-handler (KStrGetPropertyHandler). See Defining Automation Tables and Determining BDA Device Topology for more information.

Requirements

See also

KSPROPERTY_BDA_CONTROLLING_PIN_ID

KSPROPSETID_BdaTopology

KSP_BDA_NODE_PIN