Export (0) Print
Expand All

IEventSubscription interface

Specifies information about the relationship between an event subscriber and an event to which it is subscribing. It is used by publisher filters.

When to implement

You do not need to implement the IEventSubscription interface. A system-supplied event object class (CLSID_CEventSubscription) implements IEventSubscription.

When to use

After calling IMultiInterfaceEventControl::GetSubscriptions to obtain a collection of objects, a filter uses this interface to obtain information about the individual subscriptions. It is particularly important to specify one of these properties: PublisherID or EventClassID. Specifying InterfaceID restricts the events you receive to one interface. If InterfaceID is NULL, you receive events from all the interfaces on the event class object. Specifying MethodName restricts the events you receive to one method. If MethodName is NULL, you receive methods from all the interfaces.

Members

The IEventSubscription interface inherits from the IDispatch interface. IEventSubscription also has these types of members:

Methods

The IEventSubscription interface has these methods.

MethodDescription
GetPublisherProperty

Retrieves the value of a property stored in the property bag to define publisher context.

GetPublisherPropertyCollection

Retrieves a collection of properties and values stored in the publisher property bag.

GetSubscriberProperty

Retrieves the value of a property stored in the property bag to define subscriber context.

GetSubscriberPropertyCollection

Retrieves a collection of properties and values stored in the subscriber property bag.

PutPublisherProperty

Writes a property and its value to the property bag to define publisher context.

PutSubscriberProperty

Writes a property and its value to the property bag to define subscriber context.

RemovePublisherProperty

Removes a property and its value from the property bag that defines publisher context.

RemoveSubscriberProperty

Removes a property and its value from the property bag that defines subscriber context.

 

Properties

The IEventSubscription interface has these properties.

PropertyAccess typeDescription

Description

Read/write

A displayable text description of the subscription.

Enabled

Read/write

Indicates whether the subscription is enabled.

EventClassID

Read/write

The unique ID of the event class associated with the subscription.

InterfaceID

Read/write

The identifier for a particular interface for which the subscriber wants to receive events.

MachineName

Read/write

The name of the computer on which the subscriber should be activated (for a persistent subscription).

MethodName

Read/write

The name of the event method.

OwnerSID

Read/write

The security ID of the subscription's creator.

PerUser

Read/write

Indicates whether the subscription receives the event only if the owner of the subscription is logged on to the same computer as the publisher.

PublisherID

Read/write

The unique ID of the event publisher.

SubscriberCLSID

Read/write

The CLSID of the subscriber component (for a persistent subscription).

SubscriberInterface

Read/write

A marshaled pointer to the event interface on the subscriber (for a transient subscription).

SubscriptionID

Read/write

The unique ID for the subscription object.

SubscriptionName

Read/write

A displayable name for the subscription object.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

EventSys.h

IDL

EventSys.idl

 

 

Community Additions

ADD
Show:
© 2015 Microsoft