File size: 4,338 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#pragma warning disable 1634, 1691
#pragma warning disable 56506
using System;
using System.Management.Automation;
using System.Runtime.Serialization;
using System.Reflection;
using System.Security.Permissions;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// The exception that is thrown when there is no help found for a topic.
/// </summary>
public class HelpNotFoundException : SystemException, IContainsErrorRecord
{
/// <summary>
/// Initializes a new instance of the HelpNotFoundException class with the give help topic.
/// </summary>
/// <param name="helpTopic">The help topic for which help is not found.</param>
public HelpNotFoundException(string helpTopic)
: base()
{
_helpTopic = helpTopic;
CreateErrorRecord();
}
/// <summary>
/// Initializes a new instance of the HelpNotFoundException class.
/// </summary>
public HelpNotFoundException()
: base()
{
CreateErrorRecord();
}
/// <summary>
/// Initializes a new instance of the HelpNotFoundException class with the given help topic
/// and associated exception.
/// </summary>
/// <param name="helpTopic">The help topic for which help is not found.</param>
/// <param name="innerException">The inner exception.</param>
public HelpNotFoundException(string helpTopic, Exception innerException)
: base(
(innerException != null) ? innerException.Message : string.Empty,
innerException)
{
_helpTopic = helpTopic;
CreateErrorRecord();
}
/// <summary>
/// Creates an internal error record based on helpTopic.
/// The ErrorRecord created will be stored in the _errorRecord member.
/// </summary>
private void CreateErrorRecord()
{
string errMessage = string.Format(HelpErrors.HelpNotFound, _helpTopic);
// Don't do ParentContainsErrorRecordException(this), as this causes recursion, and creates a
// segmentation fault on Linux
_errorRecord = new ErrorRecord(new ParentContainsErrorRecordException(errMessage), "HelpNotFound", ErrorCategory.ResourceUnavailable, null);
_errorRecord.ErrorDetails = new ErrorDetails(typeof(HelpNotFoundException).Assembly, "HelpErrors", "HelpNotFound", _helpTopic);
}
private ErrorRecord _errorRecord;
/// <summary>
/// Gets ErrorRecord embedded in this exception.
/// </summary>
/// <value>ErrorRecord instance.</value>
public ErrorRecord ErrorRecord
{
get
{
return _errorRecord;
}
}
private readonly string _helpTopic = string.Empty;
/// <summary>
/// Gets help topic for which help is not found.
/// </summary>
/// <value>Help topic.</value>
public string HelpTopic
{
get
{
return _helpTopic;
}
}
/// <summary>
/// Gets exception message for this exception.
/// </summary>
/// <value>Error message.</value>
public override string Message
{
get
{
if (_errorRecord != null)
{
return _errorRecord.ToString();
}
return base.Message;
}
}
#region Serialization
/// <summary>
/// Initializes a new instance of the HelpNotFoundException class.
/// </summary>
/// <param name="info">Serialization information.</param>
/// <param name="context">Streaming context.</param>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected HelpNotFoundException(SerializationInfo info,
StreamingContext context)
{
throw new NotSupportedException();
}
#endregion Serialization
}
}
#pragma warning restore 56506
|