TeamFoundationExceptionFormatter.FormatException Method

Formats the specified Exception, including all inner exceptions.

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

Syntax

'Declaration
Public Shared Function FormatException ( _
    exception As Exception, _
    useBriefFormat As Boolean _
) As String

public static string FormatException(
    Exception exception,
    bool useBriefFormat
)

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

static member FormatException : 
        exception:Exception * 
        useBriefFormat:bool -> string

public static function FormatException(
    exception : Exception, 
    useBriefFormat : boolean
) : String

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.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

TeamFoundationExceptionFormatter Class

Microsoft.TeamFoundation Namespace