This documentation is archived and is not being maintained.

IMessageFilterTable<TFilterData>.GetMatchingValue Method

Returns a value that indicates whether the match criterion of a filter in the table is satisfied by the specified message or buffered message, and returns the filter data for the filter that matched.

This member is overloaded. For complete information about this member, including syntax, usage, and examples, click a name in the overload list.

  NameDescription
Public method GetMatchingValue(Message, TFilterData) Returns a value that indicates whether the match criterion of exactly one filter in the table is satisfied by the specified message, and adds the matching filter data to a collection.
Public method GetMatchingValue(MessageBuffer, TFilterData) Returns a value that indicates whether the match criterion of exactly one filter in the table is satisfied by the specified buffered message, and adds the matching filter data to a collection.
Top

Use one of these methods when, at most, one filter is expected to match the message and only the filter data from the matching filter must be recovered. These methods return a boolean that indicates whether a matching filter was found and set the data reference parameter to the matching filter data.

Use GetMatchingFilter(Message) if the body of the message is not inspected by any of the filters in the filter table.

If the body of the message may be inspected by a filter in the filter table, buffer the message and pass it to the GetMatchingFilter(MessageBuffer) version of the method.

Notes to Implementers:

If more than one filter matches the message, a MultipleFilterMatchesException must be thrown.

Show: