NBException.FormattedMessage Method

NBException FormattedMessage Method

IBM Integration Bus

Formats the exception as a string using the catalog provided in the exception itself.

Namespace: IBM.Broker.Plugin
Assembly: IBM.Broker.Plugin (in IBM.Broker.Plugin.dll) Version: 9.0.0.0

Syntax

public virtual string FormattedMessage(
	bool ignoreInserts
)

public virtual string FormattedMessage(
	bool ignoreInserts
)

Public Overridable Function FormattedMessage ( 
	ignoreInserts As Boolean
) As String

Public Overridable Function FormattedMessage ( 
	ignoreInserts As Boolean
) As String

public:
virtual String^ FormattedMessage(
	bool ignoreInserts
)

public:
virtual String^ FormattedMessage(
	bool ignoreInserts
)

abstract FormattedMessage : 
        ignoreInserts : bool -> string 
override FormattedMessage : 
        ignoreInserts : bool -> string

abstract FormattedMessage : 
        ignoreInserts : bool -> string 
override FormattedMessage : 
        ignoreInserts : bool -> string

Parameters

ignoreInserts: Type: System Boolean
If true then inserts from the exception are not added into the formatted message.

Return Value

Type:

String
String containing the formatted message, but null is returned if the message cannot be found in the catalog or the catalog cannot be found.

Exceptions

Exception	Condition
System.Security SecurityException	Thrown if the registry cannot be accessed.
System UnauthorizedAccessException	Thrown if the catalog entry in the registry cannot be accessed.

Remarks

Inserts present in the exception can be added if desired. Inserts that are null are represented by empty strings. Note that any tabs or newlines present in the formatted message are removed before the string is returned.