Sink Properties

[This is preliminary documentation and subject to change.]

Sink properties are reserved for a particular sink implementation. When the sink is notified of an event, the event dispatcher passes the collection of sink properties through an invocation of the IPersistPropertyBag::Load method. It is up to the sink application designer to decide what properties to use and whether a particular sink receives the properties at execution time. If the sink does not expose the IPersistPropertyBag interface, it is not an error. The dispatcher continues to notify the sink of the event's occurrence. The call to IPersistPropertyBag::Load always occurs before the event notification method.

One example of using sink properties is to store per-binding configuration information for a sink. In the Archiver sink example in this documentation, the sink receives the file system directory in which to save each archived message from the "ArchiveDir" sink property. In the ShieldsUp example, the response text is retrieved from the "ResponseText" source property.