PCFILTER_DESCRIPTOR structure (portcls.h)

The PCFILTER_DESCRIPTOR structure describes a miniport driver's implementation of a filter. The structure specifies the filter's pins, nodes, connections, and properties.

Syntax

typedef struct {
  ULONG                         Version;
  const PCAUTOMATION_TABLE      *AutomationTable;
  ULONG                         PinSize;
  ULONG                         PinCount;
  const PCPIN_DESCRIPTOR        *Pins;
  ULONG                         NodeSize;
  ULONG                         NodeCount;
  const PCNODE_DESCRIPTOR       *Nodes;
  ULONG                         ConnectionCount;
  const PCCONNECTION_DESCRIPTOR *Connections;
  ULONG                         CategoryCount;
  const GUID                    *Categories;
} PCFILTER_DESCRIPTOR, *PPCFILTER_DESCRIPTOR;

Members

Version

Reserved. Initialize to zero.

AutomationTable

Pointer to the automation table. This is a structure of type PCAUTOMATION_TABLE. The automation table specifies the handlers for the properties of the filter instance.

PinSize

Specifies the size in bytes of each element in the Pins array. This value should be a multiple of eight and should be at least sizeof(PCPIN_DESCRIPTOR). Larger values allow client-specific descriptor information to be appended to pin descriptors.

PinCount

Specifies the number of pin descriptors in the Pins array.

Pins

Pointer to the array of pin descriptors. Each array element is a PCPIN_DESCRIPTOR structure.

NodeSize

Specifies the size in bytes of each element in the Nodes array. This value should be a multiple of eight and should be at least sizeof(PCNODE_DESCRIPTOR). Larger values allow client-specific descriptor information to be appended to node descriptors.

NodeCount

Specifies the number of node descriptors in the Nodes array.

Nodes

Pointer to the array of node descriptors. Each array element is a PCNODE_DESCRIPTOR structure.

ConnectionCount

Specifies the number of connections in the Connections array.

Connections

Pointer to the array of connections descriptors. Each array element is a PCCONNECTION_DESCRIPTOR structure.

CategoryCount

Specifies the number of GUIDs in the Categories array.

Categories

Pointer to the array of GUIDs that specifies the categories that the object belongs to. See the discussion of topology categories in Installing Device Interfaces for an Audio Adapter.

Remarks

A port driver obtains the miniport driver's filter descriptor by calling the IMiniport::GetDescription method. The filter descriptor is a PCFILTER_DESCRIPTOR structure describing the miniport driver's pins, nodes, connections, and properties. For more information, see Filter, Pin, and Node Properties.

Requirements

See also

IMiniport::GetDescription

PCAUTOMATION_TABLE

PCCONNECTION_DESCRIPTOR

PCNODE_DESCRIPTOR

PCPIN_DESCRIPTOR