IExceptionSummaryProvider.Describe(Exception, String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 -> intPublic Function Describe (exception As Exception, ByRef additionalDetails As String) As IntegerParameters
- 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
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
