__FilterToConsumerBinding class

Article
01/07/2021

The __FilterToConsumerBinding system class is used in the registration of permanent event consumers to relate an instance of the __EventConsumer to an instance of __EventFilter.__FilterToConsumerBinding is an association class.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class __FilterToConsumerBinding : __IndicationRelated
{
  __EventConsumer REF Consumer;
  uint8               CreatorSID[];
  boolean             DeliverSynchronously = False;
  uint32              DeliveryQoS;
  __EventFilter   REF Filter;
  boolean             MaintainSecurityContext = False;
  boolean             SlowDownProviders = False;
};

Members

The __FilterToConsumerBinding class has these types of members:

Properties

Properties

The __FilterToConsumerBinding class has these properties.

Consumer

Data type: __EventConsumer
Access type: Read/write
Qualifiers: Key

Reference to an instance of __EventConsumer that represents the object path to a logical consumer, the recipient of an event. A logical consumer is an instance of a class derived from __EventConsumer.

CreatorSID

Data type: uint8 array
Access type: Read/write

Security identifier (SID) that uniquely identifies the user who created the binding. Depending on the operating system, WMI stores the Administrator SID or the SID of the user that creates an instance of __FilterToConsumerBinding. For more information, see Binding an Event Filter with a Logical Consumer and Monitoring and Responding to Events with Standard Consumers.

DeliverSynchronously

Data type: boolean
Access type: Read/write

Obsolete. Instead use the DeliveryQoS property in place of this property, because if DeliverSynchronously is set to True it overrides the setting of the DeliveryQoS property.

DeliveryQoS

Data type: uint32
Access type: Read/write

Quality of service for a subscription. If the DeliverSynchronously property is set to True, it overrides the setting of the DeliveryQoS property.

WMIMSG_FLAG_QOS_SYNCHRONOUS (0)

Synchronous delivery

False. The event is delivered to the logical consumer synchronously.

WMIMSG_FLAG_QOS_EXPRESS (1)

Express delivery

True. The event is delivered to the logical consumer asynchronously.

Filter

Data type: __EventFilter
Access type: Read/write
Qualifiers: Key

Reference to an instance of __EventFilter that represents the object path to an event filter which is a query that specifies the type of event to be received.

MaintainSecurityContext

Data type: boolean
Access type: Read/write

If True, the events are delivered in the same security context that the provider was in when it provided them.

Note

Only a consumer implemented as a DLL (an in-process consumer) can receive events in the security context of the provider. For more information about in-process providers and security, see Provider Hosting and Security. For more information and examples, see replace:Receiving Events Securely.

SlowDownProviders

Data type: boolean
Access type: Read/write

If True, providers are slowed down if this consumer cannot keep up.

Remarks

The __FilterToConsumerBinding class is derived from __IndicationRelated, which has no properties.

Permanent event consumers use the __FilterToConsumerBinding system class to bind event filters to final consumers. After the filter and consumer are bound together, WMI can forward events that match the filter to the corresponding consumer.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	All WMI namespaces