BdaPropertyTemplateConnections function (bdasup.h)

Article
06/29/2022

The BdaPropertyTemplateConnections function retrieves a list of connections that describe how pin types and node types are connected in a template topology.

Syntax

NTSTATUS BdaPropertyTemplateConnections(
  [in]            PIRP                   pIrp,
  [in]            PKSPROPERTY            pKSProperty,
  [out, optional] PKSTOPOLOGY_CONNECTION pConnectionProperty
);

Parameters

[in] pIrp

Points to the IRP for the request to retrieve the list of connections. The BDA minidriver receives this IRP with the KSPROPERTY_BDA_TEMPLATE_CONNECTIONS request.

[in] pKSProperty

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

[out, optional] pConnectionProperty

Points to an array that receives the list of KSTOPOLOGY_CONNECTION structures that describe the connections in a template topology.

Return value

Returns STATUS_SUCCESS or an appropriate error code.

Remarks

A BDA minidriver calls the BdaPropertyTemplateConnections function to retrieve the list of template connections after the minidriver receives a KSPROPERTY_BDA_TEMPLATE_CONNECTIONS 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 BdaPropertyTemplateConnections function directly, without intercepting this request using an internal get-handler (KStrGetPropertyHandler). See Defining Automation Tables and Determining BDA Device Topology for more information.

The BDA minidriver provided a list of connections to the BDA support library in an array of KSTOPOLOGY_CONNECTION structures when the BDA minidriver passed the BDA filter template (BDA_FILTER_TEMPLATE) in BdaCreateFilterFactory and BdaInitFilter function calls. This array is a representation of all the possible connections between node and pin types that can be made within the filter or between the filter and adjoining filters. The BdaPropertyTemplateConnections function returns this array.

Requirements

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