File size: 4,165 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 | // 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 category matching
/// a specific input string.
/// </summary>
public class HelpCategoryInvalidException : ArgumentException, IContainsErrorRecord
{
/// <summary>
/// Initializes a new instance of the HelpCategoryInvalidException class.
/// </summary>
/// <param name="helpCategory">The name of help category that is invalid.</param>
public HelpCategoryInvalidException(string helpCategory)
: base()
{
_helpCategory = helpCategory;
CreateErrorRecord();
}
/// <summary>
/// Initializes a new instance of the HelpCategoryInvalidException class.
/// </summary>
public HelpCategoryInvalidException()
: base()
{
CreateErrorRecord();
}
/// <summary>
/// Initializes a new instance of the HelpCategoryInvalidException class.
/// </summary>
/// <param name="helpCategory">The name of help category that is invalid.</param>
/// <param name="innerException">The inner exception of this exception.</param>
public HelpCategoryInvalidException(string helpCategory, Exception innerException)
: base(
(innerException != null) ? innerException.Message : string.Empty,
innerException)
{
_helpCategory = helpCategory;
CreateErrorRecord();
}
/// <summary>
/// Creates an internal error record based on helpCategory.
/// </summary>
private void CreateErrorRecord()
{
_errorRecord = new ErrorRecord(new ParentContainsErrorRecordException(this), "HelpCategoryInvalid", ErrorCategory.InvalidArgument, null);
_errorRecord.ErrorDetails = new ErrorDetails(typeof(HelpCategoryInvalidException).Assembly, "HelpErrors", "HelpCategoryInvalid", _helpCategory);
}
private ErrorRecord _errorRecord;
/// <summary>
/// Gets ErrorRecord embedded in this exception.
/// </summary>
/// <value>ErrorRecord instance</value>
public ErrorRecord ErrorRecord
{
get
{
return _errorRecord;
}
}
private readonly string _helpCategory = System.Management.Automation.HelpCategory.None.ToString();
/// <summary>
/// Gets name of the help category that is invalid.
/// </summary>
/// <value>Name of the help category.</value>
public string HelpCategory
{
get
{
return _helpCategory;
}
}
/// <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 HelpCategoryInvalidException 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 HelpCategoryInvalidException(SerializationInfo info,
StreamingContext context)
{
throw new NotSupportedException();
}
#endregion Serialization
}
}
#pragma warning restore 56506
|