netcore/System.Private.CoreLib/shared/System/BadImageFormatException.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 to an invalid dll or executable format.
  10 **
  11 **
  12 ===========================================================*/
  13
  14 using System.IO;
  15 using System.Runtime.Serialization;
  16
  17 namespace System
  18 {
  19     [Serializable]
  20     [System.Runtime.CompilerServices.TypeForwardedFrom("mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
  21     public partial class BadImageFormatException : SystemException
  22     {
  23         private readonly string? _fileName;  // The name of the corrupt PE file.
  24         private readonly string? _fusionLog;  // fusion log (when applicable)
  25
  26         public BadImageFormatException()
  27             : base(SR.Arg_BadImageFormatException)
  28         {
  29             HResult = HResults.COR_E_BADIMAGEFORMAT;
  30         }
  31
  32         public BadImageFormatException(string? message)
  33             : base(message)
  34         {
  35             HResult = HResults.COR_E_BADIMAGEFORMAT;
  36         }
  37
  38         public BadImageFormatException(string? message, Exception? inner)
  39             : base(message, inner)
  40         {
  41             HResult = HResults.COR_E_BADIMAGEFORMAT;
  42         }
  43
  44         public BadImageFormatException(string? message, string? fileName) : base(message)
  45         {
  46             HResult = HResults.COR_E_BADIMAGEFORMAT;
  47             _fileName = fileName;
  48         }
  49
  50         public BadImageFormatException(string? message, string? fileName, Exception? inner)
  51             : base(message, inner)
  52         {
  53             HResult = HResults.COR_E_BADIMAGEFORMAT;
  54             _fileName = fileName;
  55         }
  56
  57         protected BadImageFormatException(SerializationInfo info, StreamingContext context)
  58             : base(info, context)
  59         {
  60             _fileName = info.GetString("BadImageFormat_FileName");
  61             _fusionLog = info.GetString("BadImageFormat_FusionLog");
  62         }
  63
  64         public override void GetObjectData(SerializationInfo info, StreamingContext context)
  65         {
  66             base.GetObjectData(info, context);
  67             info.AddValue("BadImageFormat_FileName", _fileName, typeof(string));
  68             info.AddValue("BadImageFormat_FusionLog", _fusionLog, typeof(string));
  69         }
  70
  71         public override string Message
  72         {
  73             get
  74             {
  75                 SetMessageField();
  76                 return _message!;
  77             }
  78         }
  79
  80         private void SetMessageField()
  81         {
  82             if (_message == null)
  83             {
  84                 if ((_fileName == null) &&
  85                     (HResult == HResults.COR_E_EXCEPTION))
  86                     _message = SR.Arg_BadImageFormatException;
  87                 else
  88                     _message = FileLoadException.FormatFileLoadExceptionMessage(_fileName, HResult);
  89             }
  90         }
  91
  92         public string? FileName => _fileName;
  93
  94         public override string ToString()
  95         {
  96             string s = GetType().ToString() + ": " + Message;
  97
  98             if (!string.IsNullOrEmpty(_fileName))
  99                 s += Environment.NewLine + SR.Format(SR.IO_FileName_Name, _fileName);
 100
 101             if (InnerException != null)
 102                 s = s + InnerExceptionPrefix + InnerException.ToString();
 103
 104             if (StackTrace != null)
 105                 s += Environment.NewLine + StackTrace;
 106
 107             if (_fusionLog != null)
 108             {
 109                 s ??= " ";
 110                 s += Environment.NewLine;
 111                 s += Environment.NewLine;
 112                 s += _fusionLog;
 113             }
 114
 115             return s;
 116         }
 117
 118         public string? FusionLog => _fusionLog;
 119     }
 120 }