netcore/System.Private.CoreLib/shared/System/Runtime/InteropServices/ExternalException.cs

   1 // Licensed to the .NET Foundation under one or more agreements.
   2 // The .NET Foundation licenses this file to you under the MIT license.
   3 // See the LICENSE file in the project root for more information.
   4
   5 /*=============================================================================
   6 **
   7 **
   8 **
   9 ** Purpose: Exception base class for all errors from Interop or Structured
  10 **          Exception Handling code.
  11 **
  12 **
  13 =============================================================================*/
  14
  15 using System.Globalization;
  16 using System.Runtime.Serialization;
  17
  18 namespace System.Runtime.InteropServices
  19 {
  20     // Base exception for COM Interop errors &; Structured Exception Handler
  21     // exceptions.
  22     [Serializable]
  23     [System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
  24     public class ExternalException : SystemException
  25     {
  26         public ExternalException()
  27             : base(SR.Arg_ExternalException)
  28         {
  29             HResult = HResults.E_FAIL;
  30         }
  31
  32         public ExternalException(string? message)
  33             : base(message)
  34         {
  35             HResult = HResults.E_FAIL;
  36         }
  37
  38         public ExternalException(string? message, Exception? inner)
  39             : base(message, inner)
  40         {
  41             HResult = HResults.E_FAIL;
  42         }
  43
  44         public ExternalException(string? message, int errorCode)
  45             : base(message)
  46         {
  47             HResult = errorCode;
  48         }
  49
  50         protected ExternalException(SerializationInfo info, StreamingContext context)
  51             : base(info, context)
  52         {
  53         }
  54
  55         public virtual int ErrorCode => HResult;
  56
  57         public override string ToString()
  58         {
  59             string message = Message;
  60             string className = GetType().ToString();
  61
  62             string s = className + " (0x" + HResult.ToString("X8", CultureInfo.InvariantCulture) + ")";
  63
  64             if (!string.IsNullOrEmpty(message))
  65             {
  66                 s = s + ": " + message;
  67             }
  68
  69             Exception? innerException = InnerException;
  70             if (innerException != null)
  71             {
  72                 s = s + Environment.NewLine + InnerExceptionPrefix + innerException.ToString();
  73             }
  74
  75             if (StackTrace != null)
  76                 s += Environment.NewLine + StackTrace;
  77
  78             return s;
  79         }
  80     }
  81 }