CMTransport.ReviewLedger

Method

Visual Basic

Public Sub ReviewLedger(
    ByVal reviewLedgerDelegate As ReviewLedgerDelegate,
    ByVal subject As String,
    ByVal closure As Object)

C#

public void ReviewLedger(
    ReviewLedgerDelegate reviewLedgerDelegate,
    string subject,
    object closure );

Purpose

Query the ledger for stored items related to a subject name.

Remarks

The callback method receives one message for each matching subject of outbound messages stored in the ledger. For example, when FOO.* is the subject, CMTransport.ReviewLedger calls its callback delegate separately for each matching subject—once for FOO.BAR, once for FOO.BAZ, and once for FOO.BOX.

However, if the callback method returns non-null, then CMTransport.ReviewLedger returns immediately.

If the ledger does not contain any matching items, CMTransport.ReviewLedger returns normally without calling the callback method.

For information about the content and format of the callback delegate, see ReviewLedgerDelegate.

Parameter	Description
reviewLedgerDelegate	This delegate processes the review messages.
subject	Query for items related to this subject name. If this subject contains wildcard characters (* or >), then review all items with matching subject names. The callback method receives a separate message for each matching subject in the ledger.
closure	Pass this closure data to the review ledger delegate.

See Also

ReviewLedgerDelegate