This documentation is archived and is not being maintained.

TeamFoundationExceptionFormatter::FormatException Method

Formats the specified Exception, including all inner exceptions.

Namespace:  Microsoft.TeamFoundation
Assembly:  Microsoft.TeamFoundation.Common (in Microsoft.TeamFoundation.Common.dll)

public:
static String^ FormatException(
	Exception^ exception, 
	bool useBriefFormat
)

Parameters

exception
Type: System::Exception

The top-level exception to format.

useBriefFormat
Type: System::Boolean

Omits exception details form the retur value.

Return Value

Type: System::String
A formatted string that describes the exception and the nested inner exceptions.

Show: