Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 3.28 KB

nf-bdasup-bdapropertygetcontrollingpinid.md

File metadata and controls

75 lines (58 loc) · 3.28 KB
UID title description tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:bdasup.BdaPropertyGetControllingPinId
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.
stream
04/25/2022
BdaPropertyGetControllingPinId function
BdaPropertyGetControllingPinId, BdaPropertyGetControllingPinId function [Streaming Media Devices], bdaref_7f3a3695-4599-4b16-8a90-4ac171ab1ec0.xml, bdasup/BdaPropertyGetControllingPinId, stream.bdapropertygetcontrollingpinid
bdasup.h
Bdasup.h
Desktop
Bdasup.lib
PASSIVE_LEVEL
Windows
BdaPropertyGetControllingPinId
bdasup/BdaPropertyGetControllingPinId
APIRef
kbSyntax
LibDef
Bdasup.lib
Bdasup.dll
BdaPropertyGetControllingPinId

-description

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

-parameters

-param Irp [in]

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.

-param Property [in]

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.

-param pulControllingPinId [out, optional]

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

-returns

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.

-see-also

KSPROPERTY_BDA_CONTROLLING_PIN_ID

KSPROPSETID_BdaTopology

KSP_BDA_NODE_PIN