File size: 8,534 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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation.Internal;
using System.Runtime.Serialization;
namespace System.Management.Automation.Host
{
/// <summary>
/// Defines the exception thrown when the Host cannot complete an operation
/// such as checking whether there is any input available.
/// </summary>
public
class HostException : RuntimeException
{
#region ctors
/// <summary>
/// Initializes a new instance of the HostException class.
/// </summary>
public
HostException()
: base(StringUtil.Format(HostInterfaceExceptionsStrings.DefaultCtorMessageTemplate, typeof(HostException).FullName))
{
SetDefaultErrorRecord();
}
/// <summary>
/// Initializes a new instance of the HostException class and defines the error message.
/// </summary>
/// <param name="message">
/// The error message that explains the reason for the exception.
/// </param>
public
HostException(string message)
: base(message)
{
SetDefaultErrorRecord();
}
/// <summary>
/// Initializes a new instance of the HostException class and defines the error message and
/// inner exception.
/// </summary>
/// <param name="message">
/// The error message that explains the reason for the exception.
/// </param>
/// <param name="innerException">
/// The exception that is the cause of the current exception. If the <paramref name="innerException"/>
/// parameter is not a null reference, the current exception is raised in a catch
/// block that handles the inner exception.
/// </param>
public
HostException(string message, Exception innerException)
: base(message, innerException)
{
SetDefaultErrorRecord();
}
/// <summary>
/// Initializes a new instance of the HostException class and defines the error message,
/// inner exception, the error ID, and the error category.
/// </summary>
/// <param name="message">
/// The error message that explains the reason for the exception.
/// </param>
/// <param name="innerException">
/// The exception that is the cause of the current exception. If the <paramref name="innerException"/>
/// parameter is not a null reference, the current exception is raised in a catch
/// block that handles the inner exception.
/// </param>
/// <param name="errorId">
/// The string that should uniquely identifies the situation where the exception is thrown.
/// The string should not contain white space.
/// </param>
/// <param name="errorCategory">
/// The ErrorCategory into which this exception situation falls
/// </param>
/// <remarks>
/// Intentionally public, third-party hosts can call this
/// </remarks>
public
HostException(
string message,
Exception innerException,
string errorId,
ErrorCategory errorCategory)
: base(message, innerException)
{
SetErrorId(errorId);
SetErrorCategory(errorCategory);
}
/// <summary>
/// Initializes a new instance of the HostException class and defines the SerializationInfo
/// and the StreamingContext.
/// </summary>
/// <param name="info">
/// The object that holds the serialized object data.
/// </param>
/// <param name="context">
/// The contextual information about the source or destination.
/// </param>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected
HostException(SerializationInfo info, StreamingContext context)
{
throw new NotSupportedException();
}
#endregion
#region private
private void SetDefaultErrorRecord()
{
SetErrorCategory(ErrorCategory.ResourceUnavailable);
SetErrorId(typeof(HostException).FullName);
}
#endregion
}
/// <summary>
/// Defines the exception thrown when an error occurs from prompting for a command parameter.
/// </summary>
public
class PromptingException : HostException
{
#region ctors
/// <summary>
/// Initializes a new instance of the PromptingException class.
/// </summary>
public
PromptingException()
: base(StringUtil.Format(HostInterfaceExceptionsStrings.DefaultCtorMessageTemplate, typeof(PromptingException).FullName))
{
SetDefaultErrorRecord();
}
/// <summary>
/// Initializes a new instance of the PromptingException class and defines the error message.
/// </summary>
/// <param name="message">
/// The error message that explains the reason for the exception.
/// </param>
public
PromptingException(string message)
: base(message)
{
SetDefaultErrorRecord();
}
/// <summary>
/// Initializes a new instance of the PromptingException class and defines the error message and
/// inner exception.
/// </summary>
/// <param name="message">
/// The error message that explains the reason for the exception.
/// </param>
/// <param name="innerException">
/// The exception that is the cause of the current exception. If the <paramref name="innerException"/>
/// parameter is not a null reference, the current exception is raised in a catch
/// block that handles the inner exception.
/// </param>
public
PromptingException(string message, Exception innerException)
: base(message, innerException)
{
SetDefaultErrorRecord();
}
/// <summary>
/// Initializes a new instance of the PromptingException class and defines the error message,
/// inner exception, the error ID, and the error category.
/// </summary>
/// <param name="message">
/// The error message that explains the reason for the exception.
/// </param>
/// <param name="innerException">
/// The exception that is the cause of the current exception. If the <paramref name="innerException"/>
/// parameter is not a null reference, the current exception is raised in a catch
/// block that handles the inner exception.
/// </param>
/// <param name="errorId">
/// The string that should uniquely identifies the situation where the exception is thrown.
/// The string should not contain white space.
/// </param>
/// <param name="errorCategory">
/// The ErrorCategory into which this exception situation falls
/// </param>
/// <remarks>
/// Intentionally public, third-party hosts can call this
/// </remarks>
public
PromptingException(
string message,
Exception innerException,
string errorId,
ErrorCategory errorCategory)
: base(message, innerException, errorId, errorCategory)
{
}
/// <summary>
/// Initializes a new instance of the HostException class and defines the SerializationInfo
/// and the StreamingContext.
/// </summary>
/// <param name="info">
/// The object that holds the serialized object data.
/// </param>
/// <param name="context">
/// The contextual information about the source or destination.
/// </param>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected
PromptingException(SerializationInfo info, StreamingContext context)
{
throw new NotSupportedException();
}
#endregion
#region private
private void SetDefaultErrorRecord()
{
SetErrorCategory(ErrorCategory.ResourceUnavailable);
SetErrorId(typeof(PromptingException).FullName);
}
#endregion
}
}
|