ExceptionFormatter BuildActionableException Method

This method will build an exception detail for actionable messages. The presentation of the message will be in the following general format: actionableSuggestions[newline] introductionMessage[newline]exception(defaults to message only).

Namespace:  Scribe.Core.ConnectorApi.Exceptions

Assembly:  Scribe.Core.ConnectorApi (in Scribe.Core.ConnectorApi.dll)

Syntax

public   static   string   BuildActionableException(
	string   actionableSuggestions,
	string   introductionMessage,
	Exception   exception,
	bool   reportExceptionDetail = false
)

Parameters

actionableSuggestions

Type: System String

This parameter holds the actionable suggestions to the user.

introductionMessage

Type: System String

This parameter holds the introduction message to the real exception.

exception

Type: System Exception

This parameter references the real exception that was caught.

reportExceptionDetail (Optional)

Type: System Boolean

This parameter holds whether the exception details are reported (default is false).

Return Value

Type: String

This returns the formatted message to the user.

See

ExceptionFormatter Class

Scribe.Core.ConnectorApi.Exceptions Namespace