[TIBCO.EMS .NET Admin client library 6.3 documentation]

Returns a summary of the contents of the transport's ledger file.

Namespace:  TIBCO.EMS.ADMIN
Assembly:  TIBCO.EMS.ADMIN (in TIBCO.EMS.ADMIN.dll)

Syntax

public CMLedgerSubjectInfo[] GetCMLedger(
	string transport,
	string pattern
)
Public Function GetCMLedger ( _
	transport As String, _
	pattern As String _
) As CMLedgerSubjectInfo()
public:
array<CMLedgerSubjectInfo^>^ GetCMLedger(
	String^ transport, 
	String^ pattern
)

Parameters

transport
Type: System..::.String
the name of the transport whose ledger file is to be summarized.
pattern
Type: System..::.String
a pattern indicating which subjects are of interest.

Return Value

array of CMLedgerSubjectInfo objects that match the given pattern.

Remarks

Specifying a pattern limits the scope of the query to only those Rendezvous subjects matching the pattern. The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work. A pattern of "", ">", or null will return information on all the subjects in the ledger file.

Exceptions

ExceptionCondition
TIBCO.EMS.ADMIN..::.AdminExceptionif not authorized or an error occurred.

See Also