BdaPropertyNodeDescriptors function (bdasup.h)

Article
02/22/2024

The BdaPropertyNodeDescriptors function retrieves a list of nodes in a template topology.

Syntax

NTSTATUS BdaPropertyNodeDescriptors(
  [in]            PIRP               pIrp,
  [in]            PKSPROPERTY        pKSProperty,
  [out, optional] BDANODE_DESCRIPTOR *pNodeDescriptorProperty
);

Parameters

[in] pIrp

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

[in] pKSProperty

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

[out, optional] pNodeDescriptorProperty

Points to an array that receives the list of GUIDs for the nodes in a template topology.

Return value

Returns STATUS_SUCCESS or an appropriate error code.

Remarks

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

For a list of BDA nodes that are available to create in a template topology, see BDA Node Category GUIDs.

Requirements

Requirement	Value
Minimum supported client	Available on Microsoft Windows XP and later operating systems. This routine is available on the Windows 2000 platform only if Microsoft DirectX 9.0 and later is installed on that platform.
Target Platform	Desktop
Header	bdasup.h (include Bdasup.h)
Library	Bdasup.lib
IRQL	PASSIVE_LEVEL