ExceptionFormatter.FormatExceptionForDisplay Method

Formats the specified exception to be displayed and read by a user.

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

Syntax

'Declaration
Public Shared Function FormatExceptionForDisplay ( _
    ex As Exception _
) As String

public static string FormatExceptionForDisplay(
    Exception ex
)

public:
static String^ FormatExceptionForDisplay(
    Exception^ ex
)

static member FormatExceptionForDisplay : 
        ex:Exception -> string

public static function FormatExceptionForDisplay(
    ex : Exception
) : String

Parameters

• ex
  Type: System.Exception

  The exception to format.

Return Value

Type: System.String
A user-readable string describing the exception.

.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

ExceptionFormatter Class

Microsoft.TeamFoundation.Common Namespace