Share via


IExceptionSummaryProvider.Describe(Exception, String) Method

Definition

Provides the index of the description for the exception along with optional additional data.

public:
 int Describe(Exception ^ exception, [Runtime::InteropServices::Out] System::String ^ % additionalDetails);
public int Describe (Exception exception, out string? additionalDetails);
abstract member Describe : Exception * string -> int
Public Function Describe (exception As Exception, ByRef additionalDetails As String) As Integer

Parameters

exception
Exception

The exception.

additionalDetails
String

The additional details of the given exception, if any. Ideally, this string should not contain any privacy-sensitive information.

Returns

The index of the description.

Remarks

This method should only get invoked with an exception which is type compatible with a type described by SupportedExceptionTypes.

Applies to