mirror of https://github.com/dahall/Vanara.git
Cleaned Win32Error and fixed some docs
dahall
parent
dba346c0d0
commit
51bd754440
|
|
@ -4,297 +4,283 @@ using System.Globalization;
|
|||
using System.Runtime.InteropServices;
|
||||
using System.Security;
|
||||
|
||||
namespace Vanara.PInvoke
|
||||
namespace Vanara.PInvoke;
|
||||
|
||||
/// <summary>Represents a Win32 Error Code. This can be used in place of a return value.</summary>
|
||||
[StructLayout(LayoutKind.Sequential, Pack = 4)]
|
||||
[TypeConverter(typeof(Win32ErrorTypeConverter))]
|
||||
[PInvokeData("winerr.h")]
|
||||
public partial struct Win32Error : IEquatable<Win32Error>, IEquatable<uint>, IConvertible, IComparable<Win32Error>, IComparable, IErrorProvider
|
||||
{
|
||||
/// <summary>Represents a Win32 Error Code. This can be used in place of a return value.</summary>
|
||||
[StructLayout(LayoutKind.Sequential, Pack = 4)]
|
||||
[TypeConverter(typeof(Win32ErrorTypeConverter))]
|
||||
[PInvokeData("winerr.h")]
|
||||
public partial struct Win32Error : IEquatable<Win32Error>, IEquatable<uint>, IConvertible, IComparable<Win32Error>, IComparable, IErrorProvider
|
||||
internal readonly uint value;
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="Win32Error"/> struct with an error value.</summary>
|
||||
/// <param name="i">The error value.</param>
|
||||
public Win32Error(uint i) => value = i;
|
||||
|
||||
/// <summary>Gets a value indicating whether this <see cref="Win32Error"/> is a failure.</summary>
|
||||
/// <value><see langword="true"/> if failed; otherwise, <see langword="false"/>.</value>
|
||||
public bool Failed => !Succeeded;
|
||||
|
||||
/// <summary>Gets a value indicating whether this <see cref="Win32Error"/> is a success.</summary>
|
||||
/// <value><see langword="true"/><see langword="true"/> if succeeded; otherwise, <see langword="false"/>.</value>
|
||||
public bool Succeeded => value == ERROR_SUCCESS;
|
||||
|
||||
/// <summary>Performs an explicit conversion from <see cref="Win32Error"/> to <see cref="HRESULT"/>.</summary>
|
||||
/// <param name="error">The error.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static explicit operator HRESULT(Win32Error error) =>
|
||||
unchecked((int)error.value) <= 0 ? unchecked((int)error.value) : HRESULT.Make(true, HRESULT.FacilityCode.FACILITY_WIN32, error.value & 0xffff);
|
||||
|
||||
/// <summary>Performs an explicit conversion from <see cref="Win32Error"/> to <see cref="int"/>.</summary>
|
||||
/// <param name="value">The value.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static explicit operator uint(Win32Error value) => value.value;
|
||||
|
||||
/// <summary>Tries to extract a Win32Error from an exception.</summary>
|
||||
/// <param name="exception">The exception.</param>
|
||||
/// <returns>The error. If undecipherable, ERROR_UNIDENTIFIED_ERROR is returned.</returns>
|
||||
public static Win32Error FromException(Exception exception)
|
||||
{
|
||||
internal readonly uint value;
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="Win32Error"/> struct with an error value.</summary>
|
||||
/// <param name="i">The i.</param>
|
||||
public Win32Error(uint i) => value = i;
|
||||
|
||||
/// <summary>Gets a value indicating whether this <see cref="Win32Error"/> is a failure.</summary>
|
||||
/// <value><c>true</c> if failed; otherwise, <c>false</c>.</value>
|
||||
public bool Failed => !Succeeded;
|
||||
|
||||
/// <summary>Gets a value indicating whether this <see cref="Win32Error"/> is a success.</summary>
|
||||
/// <value><c>true</c> if succeeded; otherwise, <c>false</c>.</value>
|
||||
public bool Succeeded => value == ERROR_SUCCESS;
|
||||
|
||||
/// <summary>Performs an explicit conversion from <see cref="Win32Error"/> to <see cref="HRESULT"/>.</summary>
|
||||
/// <param name="error">The error.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static explicit operator HRESULT(Win32Error error) =>
|
||||
unchecked((int)error.value) <= 0 ? unchecked((int)error.value) : HRESULT.Make(true, HRESULT.FacilityCode.FACILITY_WIN32, error.value & 0xffff);
|
||||
|
||||
/// <summary>Performs an explicit conversion from <see cref="Win32Error"/> to <see cref="System.Int32"/>.</summary>
|
||||
/// <param name="value">The value.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static explicit operator uint(Win32Error value) => value.value;
|
||||
|
||||
/// <summary>Tries to extract a Win32Error from an exception.</summary>
|
||||
/// <param name="exception">The exception.</param>
|
||||
/// <returns>The error. If undecipherable, ERROR_UNIDENTIFIED_ERROR is returned.</returns>
|
||||
public static Win32Error FromException(Exception exception)
|
||||
{
|
||||
if (exception is Win32Exception we)
|
||||
return unchecked((uint)we.NativeErrorCode);
|
||||
if (exception.InnerException is Win32Exception iwe)
|
||||
return unchecked((uint)iwe.NativeErrorCode);
|
||||
var hr = new HRESULT(exception.HResult);
|
||||
if (hr.Facility == HRESULT.FacilityCode.FACILITY_WIN32)
|
||||
return unchecked((uint)hr.Code);
|
||||
return ERROR_UNIDENTIFIED_ERROR;
|
||||
}
|
||||
|
||||
/// <summary>Gets the last error.</summary>
|
||||
/// <returns></returns>
|
||||
[SecurityCritical]
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public static Win32Error GetLastError() => new Win32Error(ExtGetLastError());
|
||||
|
||||
/// <summary>Performs an explicit conversion from <see cref="System.Int32"/> to <see cref="Win32Error"/>.</summary>
|
||||
/// <param name="value">The value.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static implicit operator Win32Error(uint value) => new Win32Error(value);
|
||||
|
||||
/// <summary>Implements the operator !=.</summary>
|
||||
/// <param name="errLeft">The error left.</param>
|
||||
/// <param name="errRight">The error right.</param>
|
||||
/// <returns>The result of the operator.</returns>
|
||||
public static bool operator !=(Win32Error errLeft, Win32Error errRight) => errLeft.value != errRight.value;
|
||||
|
||||
/// <summary>Implements the operator !=.</summary>
|
||||
/// <param name="errLeft">The error left.</param>
|
||||
/// <param name="errRight">The error right.</param>
|
||||
/// <returns>The result of the operator.</returns>
|
||||
public static bool operator !=(Win32Error errLeft, uint errRight) => errLeft.value != errRight;
|
||||
|
||||
/// <summary>Implements the operator ==.</summary>
|
||||
/// <param name="errLeft">The error left.</param>
|
||||
/// <param name="errRight">The error right.</param>
|
||||
/// <returns>The result of the operator.</returns>
|
||||
public static bool operator ==(Win32Error errLeft, Win32Error errRight) => errLeft.value == errRight.value;
|
||||
|
||||
/// <summary>Implements the operator ==.</summary>
|
||||
/// <param name="errLeft">The error left.</param>
|
||||
/// <param name="errRight">The error right.</param>
|
||||
/// <returns>The result of the operator.</returns>
|
||||
public static bool operator ==(Win32Error errLeft, uint errRight) => errLeft.value == errRight;
|
||||
|
||||
/// <summary>Throws if failed.</summary>
|
||||
/// <param name="err">The error.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public static void ThrowIfFailed(Win32Error err, string message = null) => err.ThrowIfFailed(message);
|
||||
|
||||
/// <summary>Throws the last error.</summary>
|
||||
/// <param name="message">The message to associate with the exception.</param>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public static void ThrowLastError(string message = null) => GetLastError().ThrowIfFailed(message);
|
||||
|
||||
/// <summary>Throws the last error if the predicate delegate returns <see langword="true"/>.</summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <param name="value">The value to check.</param>
|
||||
/// <param name="valueIsFailure">The delegate which returns <see langword="true"/> on failure.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
/// <returns>The <paramref name="value"/> passed in on success.</returns>
|
||||
public static T ThrowLastErrorIf<T>(T value, Func<T, bool> valueIsFailure, string message = null)
|
||||
{
|
||||
if (valueIsFailure(value))
|
||||
GetLastError().ThrowIfFailed(message);
|
||||
return value;
|
||||
}
|
||||
|
||||
/// <summary>Throws the last error if the function returns <see langword="false"/>.</summary>
|
||||
/// <param name="value">The value to check.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
public static bool ThrowLastErrorIfFalse(bool value, string message = null) => ThrowLastErrorIf(value, v => !v, message);
|
||||
|
||||
/// <summary>Throws the last error if the value is an invalid handle.</summary>
|
||||
/// <param name="value">The SafeHandle to check.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
public static T ThrowLastErrorIfInvalid<T>(T value, string message = null) where T : SafeHandle => ThrowLastErrorIf(value, v => v.IsInvalid, message);
|
||||
|
||||
/// <summary>Throws the last error if the value is a NULL pointer (IntPtr.Zero).</summary>
|
||||
/// <param name="value">The pointer to check.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
public static IntPtr ThrowLastErrorIfNull(IntPtr value, string message = null) => ThrowLastErrorIf(value, v => v == IntPtr.Zero, message);
|
||||
|
||||
/// <summary>Throws if the last error failed, unless the error is the specified value.</summary>
|
||||
/// <param name="exception">The failure code to ignore.</param>
|
||||
/// <param name="message">The message to associate with the exception.</param>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public static void ThrowLastErrorUnless(Win32Error exception, string message = null) => GetLastError().ThrowUnless(exception, message);
|
||||
|
||||
/// <summary>Compares the current object with another object of the same type.</summary>
|
||||
/// <param name="other">An object to compare with this object.</param>
|
||||
/// <returns>
|
||||
/// A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value
|
||||
/// Meaning Less than zero This object is less than the <paramref name="other"/> parameter.Zero This object is equal to <paramref
|
||||
/// name="other"/>. Greater than zero This object is greater than <paramref name="other"/>.
|
||||
/// </returns>
|
||||
public int CompareTo(Win32Error other) => value.CompareTo(other.value);
|
||||
|
||||
/// <summary>
|
||||
/// Compares the current instance with another object of the same type and returns an integer that indicates whether the current
|
||||
/// instance precedes, follows, or occurs in the same position in the sort order as the other object.
|
||||
/// </summary>
|
||||
/// <param name="obj">An object to compare with this instance.</param>
|
||||
/// <returns>
|
||||
/// A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less
|
||||
/// than zero This instance precedes <paramref name="obj"/> in the sort order. Zero This instance occurs in the same position in the
|
||||
/// sort order as <paramref name="obj"/>. Greater than zero This instance follows <paramref name="obj"/> in the sort order.
|
||||
/// </returns>
|
||||
public int CompareTo(object obj)
|
||||
{
|
||||
var v = ValueFromObj(obj);
|
||||
return v.HasValue
|
||||
? value.CompareTo(v.Value)
|
||||
: throw new ArgumentException(@"Object cannot be converted to a Int32 value for comparison.", nameof(obj));
|
||||
}
|
||||
|
||||
/// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
|
||||
/// <param name="other">An object to compare with this object.</param>
|
||||
/// <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
|
||||
/// <exception cref="System.NotImplementedException"></exception>
|
||||
public bool Equals(uint other) => other == value;
|
||||
|
||||
/// <summary>Determines whether the specified <see cref="System.Object"/>, is equal to this instance.</summary>
|
||||
/// <param name="obj">The <see cref="System.Object"/> to compare with this instance.</param>
|
||||
/// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
|
||||
public override bool Equals(object obj) => Equals(value, ValueFromObj(obj));
|
||||
|
||||
/// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
|
||||
/// <param name="other">An object to compare with this object.</param>
|
||||
/// <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
|
||||
/// <exception cref="System.NotImplementedException"></exception>
|
||||
public bool Equals(Win32Error other) => other.value == value;
|
||||
|
||||
/// <summary>Gets the .NET <see cref="Exception"/> associated with the HRESULT value and optionally adds the supplied message.</summary>
|
||||
/// <param name="message">The optional message to assign to the <see cref="Exception"/>.</param>
|
||||
/// <returns>The associated <see cref="Exception"/> or <c>null</c> if this HRESULT is not a failure.</returns>
|
||||
[SecurityCritical, SecuritySafeCritical]
|
||||
public Exception GetException(string message = null) => Succeeded ? null : ToHRESULT().GetException(message);
|
||||
|
||||
/// <summary>Returns a hash code for this instance.</summary>
|
||||
/// <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
|
||||
public override int GetHashCode() => unchecked((int)value);
|
||||
|
||||
/// <summary>Throws if failed.</summary>
|
||||
/// <param name="message">The message.</param>
|
||||
/// <exception cref="Win32Exception"></exception>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public void ThrowIfFailed(string message = null)
|
||||
{
|
||||
if (value != ERROR_SUCCESS) throw GetException(message);
|
||||
}
|
||||
|
||||
/// <summary>Throws if failed, unless the error is the specified value.</summary>
|
||||
/// <param name="exception">The failure code to ignore.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public void ThrowUnless(Win32Error exception, string message = null)
|
||||
{
|
||||
if (value != ERROR_SUCCESS && value != (uint)exception) throw GetException(message);
|
||||
}
|
||||
|
||||
/// <summary>Converts this error to an <see cref="HRESULT"/>.</summary>
|
||||
/// <returns>The <see cref="HRESULT"/> equivalent of this error.</returns>
|
||||
public HRESULT ToHRESULT() => (HRESULT)this;
|
||||
|
||||
/// <summary>Returns a <see cref="System.String"/> that represents this instance.</summary>
|
||||
/// <returns>A <see cref="System.String"/> that represents this instance.</returns>
|
||||
public override string ToString()
|
||||
{
|
||||
StaticFieldValueHash.TryGetFieldName<Win32Error, uint>(value, out var err);
|
||||
var msg = HRESULT.FormatMessage(value);
|
||||
return (err ?? string.Format(CultureInfo.InvariantCulture, "0x{0:X8}", value)) + (msg == null ? "" : ": " + msg);
|
||||
}
|
||||
|
||||
TypeCode IConvertible.GetTypeCode() => value.GetTypeCode();
|
||||
|
||||
bool IConvertible.ToBoolean(IFormatProvider provider) => Succeeded;
|
||||
|
||||
byte IConvertible.ToByte(IFormatProvider provider) => ((IConvertible)value).ToByte(provider);
|
||||
|
||||
char IConvertible.ToChar(IFormatProvider provider) => throw new NotSupportedException();
|
||||
|
||||
DateTime IConvertible.ToDateTime(IFormatProvider provider) => throw new NotSupportedException();
|
||||
|
||||
decimal IConvertible.ToDecimal(IFormatProvider provider) => ((IConvertible)value).ToDecimal(provider);
|
||||
|
||||
double IConvertible.ToDouble(IFormatProvider provider) => ((IConvertible)value).ToDouble(provider);
|
||||
|
||||
short IConvertible.ToInt16(IFormatProvider provider) => ((IConvertible)value).ToInt16(provider);
|
||||
|
||||
int IConvertible.ToInt32(IFormatProvider provider) => ((IConvertible)value).ToInt32(provider);
|
||||
|
||||
long IConvertible.ToInt64(IFormatProvider provider) => ((IConvertible)value).ToInt64(provider);
|
||||
|
||||
sbyte IConvertible.ToSByte(IFormatProvider provider) => ((IConvertible)value).ToSByte(provider);
|
||||
|
||||
float IConvertible.ToSingle(IFormatProvider provider) => ((IConvertible)value).ToSingle(provider);
|
||||
|
||||
string IConvertible.ToString(IFormatProvider provider) => ToString();
|
||||
|
||||
object IConvertible.ToType(Type conversionType, IFormatProvider provider) =>
|
||||
((IConvertible)value).ToType(conversionType, provider);
|
||||
|
||||
ushort IConvertible.ToUInt16(IFormatProvider provider) => ((IConvertible)value).ToUInt16(provider);
|
||||
|
||||
uint IConvertible.ToUInt32(IFormatProvider provider) => ((IConvertible)value).ToUInt32(provider);
|
||||
|
||||
ulong IConvertible.ToUInt64(IFormatProvider provider) => ((IConvertible)value).ToUInt64(provider);
|
||||
|
||||
[DllImport(Lib.Kernel32, SetLastError = false, EntryPoint = "GetLastError")]
|
||||
private static extern uint ExtGetLastError();
|
||||
|
||||
private static uint? ValueFromObj(object obj)
|
||||
{
|
||||
if (obj == null) return null;
|
||||
var c = TypeDescriptor.GetConverter(obj);
|
||||
return c.CanConvertTo(typeof(uint)) ? (uint?)c.ConvertTo(obj, typeof(uint)) : null;
|
||||
}
|
||||
if (exception is Win32Exception we)
|
||||
return unchecked((uint)we.NativeErrorCode);
|
||||
if (exception.InnerException is Win32Exception iwe)
|
||||
return unchecked((uint)iwe.NativeErrorCode);
|
||||
var hr = new HRESULT(exception.HResult);
|
||||
return hr.Facility == HRESULT.FacilityCode.FACILITY_WIN32 ? (Win32Error)(uint)hr.Code : (Win32Error)ERROR_UNIDENTIFIED_ERROR;
|
||||
}
|
||||
|
||||
internal class Win32ErrorTypeConverter : TypeConverter
|
||||
/// <summary>Gets the last error.</summary>
|
||||
/// <returns>The last error.</returns>
|
||||
[SecurityCritical]
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public static Win32Error GetLastError() => new(ExtGetLastError());
|
||||
|
||||
/// <summary>Performs an explicit conversion from <see cref="int"/> to <see cref="Win32Error"/>.</summary>
|
||||
/// <param name="value">The value.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static implicit operator Win32Error(uint value) => new(value);
|
||||
|
||||
/// <summary>Implements the operator !=.</summary>
|
||||
/// <param name="errLeft">The error left.</param>
|
||||
/// <param name="errRight">The error right.</param>
|
||||
/// <returns>The result of the operator.</returns>
|
||||
public static bool operator !=(Win32Error errLeft, Win32Error errRight) => errLeft.value != errRight.value;
|
||||
|
||||
/// <summary>Implements the operator !=.</summary>
|
||||
/// <param name="errLeft">The error left.</param>
|
||||
/// <param name="errRight">The error right.</param>
|
||||
/// <returns>The result of the operator.</returns>
|
||||
public static bool operator !=(Win32Error errLeft, uint errRight) => errLeft.value != errRight;
|
||||
|
||||
/// <summary>Implements the operator ==.</summary>
|
||||
/// <param name="errLeft">The error left.</param>
|
||||
/// <param name="errRight">The error right.</param>
|
||||
/// <returns>The result of the operator.</returns>
|
||||
public static bool operator ==(Win32Error errLeft, Win32Error errRight) => errLeft.value == errRight.value;
|
||||
|
||||
/// <summary>Implements the operator ==.</summary>
|
||||
/// <param name="errLeft">The error left.</param>
|
||||
/// <param name="errRight">The error right.</param>
|
||||
/// <returns>The result of the operator.</returns>
|
||||
public static bool operator ==(Win32Error errLeft, uint errRight) => errLeft.value == errRight;
|
||||
|
||||
/// <summary>Throws if failed.</summary>
|
||||
/// <param name="err">The error.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public static void ThrowIfFailed(Win32Error err, string message = null) => err.ThrowIfFailed(message);
|
||||
|
||||
/// <summary>Throws the last error.</summary>
|
||||
/// <param name="message">The message to associate with the exception.</param>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public static void ThrowLastError(string message = null) => GetLastError().ThrowIfFailed(message);
|
||||
|
||||
/// <summary>Throws the last error if the predicate delegate returns <see langword="true"/>.</summary>
|
||||
/// <typeparam name="T">The type of the value to evaluate.</typeparam>
|
||||
/// <param name="value">The value to check.</param>
|
||||
/// <param name="valueIsFailure">The delegate which returns <see langword="true"/> on failure.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
/// <returns>The <paramref name="value"/> passed in on success.</returns>
|
||||
public static T ThrowLastErrorIf<T>(T value, Func<T, bool> valueIsFailure, string message = null)
|
||||
{
|
||||
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
|
||||
{
|
||||
if (sourceType.IsPrimitive && sourceType != typeof(bool) && sourceType != typeof(char))
|
||||
return true;
|
||||
return base.CanConvertFrom(context, sourceType);
|
||||
}
|
||||
if (valueIsFailure(value))
|
||||
GetLastError().ThrowIfFailed(message);
|
||||
return value;
|
||||
}
|
||||
|
||||
public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)
|
||||
{
|
||||
if (destinationType == typeof(string) || destinationType.IsPrimitive && destinationType != typeof(char))
|
||||
return true;
|
||||
return base.CanConvertTo(context, destinationType);
|
||||
}
|
||||
/// <summary>Throws the last error if the function returns <see langword="false"/>.</summary>
|
||||
/// <param name="value">The value to check.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
public static bool ThrowLastErrorIfFalse(bool value, string message = null) => ThrowLastErrorIf(value, v => !v, message);
|
||||
|
||||
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
|
||||
{
|
||||
if (value != null && value.GetType().IsPrimitive && !(value is char) && !(value is bool))
|
||||
return new Win32Error((uint)Convert.ChangeType(value, TypeCode.UInt32));
|
||||
return base.ConvertFrom(context, culture, value);
|
||||
}
|
||||
/// <summary>Throws the last error if the value is an invalid handle.</summary>
|
||||
/// <param name="value">The SafeHandle to check.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
public static T ThrowLastErrorIfInvalid<T>(T value, string message = null) where T : SafeHandle => ThrowLastErrorIf(value, v => v.IsInvalid, message);
|
||||
|
||||
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value,
|
||||
Type destinationType)
|
||||
{
|
||||
if (!(value is Win32Error err)) throw new NotSupportedException();
|
||||
if (destinationType.IsPrimitive && destinationType != typeof(char))
|
||||
return Convert.ChangeType(err, destinationType);
|
||||
if (destinationType == typeof(string))
|
||||
return err.ToString();
|
||||
return base.ConvertTo(context, culture, value, destinationType);
|
||||
}
|
||||
/// <summary>Throws the last error if the value is a NULL pointer (IntPtr.Zero).</summary>
|
||||
/// <param name="value">The pointer to check.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
public static IntPtr ThrowLastErrorIfNull(IntPtr value, string message = null) => ThrowLastErrorIf(value, v => v == IntPtr.Zero, message);
|
||||
|
||||
/// <summary>Throws if the last error failed, unless the error is the specified value.</summary>
|
||||
/// <param name="exception">The failure code to ignore.</param>
|
||||
/// <param name="message">The message to associate with the exception.</param>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public static void ThrowLastErrorUnless(Win32Error exception, string message = null) => GetLastError().ThrowUnless(exception, message);
|
||||
|
||||
/// <summary>Compares the current object with another object of the same type.</summary>
|
||||
/// <param name="other">An object to compare with this object.</param>
|
||||
/// <returns>
|
||||
/// A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning
|
||||
/// Less than zero This object is less than the <paramref name="other"/> parameter.Zero This object is equal to <paramref name="other"/>.
|
||||
/// Greater than zero This object is greater than <paramref name="other"/>.
|
||||
/// </returns>
|
||||
public int CompareTo(Win32Error other) => value.CompareTo(other.value);
|
||||
|
||||
/// <summary>
|
||||
/// Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance
|
||||
/// precedes, follows, or occurs in the same position in the sort order as the other object.
|
||||
/// </summary>
|
||||
/// <param name="obj">An object to compare with this instance.</param>
|
||||
/// <returns>
|
||||
/// A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than
|
||||
/// zero This instance precedes <paramref name="obj"/> in the sort order. Zero This instance occurs in the same position in the sort
|
||||
/// order as <paramref name="obj"/>. Greater than zero This instance follows <paramref name="obj"/> in the sort order.
|
||||
/// </returns>
|
||||
public int CompareTo(object obj)
|
||||
{
|
||||
var v = ValueFromObj(obj);
|
||||
return v.HasValue
|
||||
? value.CompareTo(v.Value)
|
||||
: throw new ArgumentException(@"Object cannot be converted to a Int32 value for comparison.", nameof(obj));
|
||||
}
|
||||
|
||||
/// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
|
||||
/// <param name="other">An object to compare with this object.</param>
|
||||
/// <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
|
||||
/// <exception cref="System.NotImplementedException"></exception>
|
||||
public bool Equals(uint other) => other == value;
|
||||
|
||||
/// <summary>Determines whether the specified <see cref="object"/>, is equal to this instance.</summary>
|
||||
/// <param name="obj">The <see cref="object"/> to compare with this instance.</param>
|
||||
/// <returns><see langword="true"/> if the specified <see cref="object"/> is equal to this instance; otherwise, <see langword="false"/>.</returns>
|
||||
public override bool Equals(object obj) => Equals(value, ValueFromObj(obj));
|
||||
|
||||
/// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
|
||||
/// <param name="other">An object to compare with this object.</param>
|
||||
/// <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
|
||||
/// <exception cref="System.NotImplementedException"></exception>
|
||||
public bool Equals(Win32Error other) => other.value == value;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the .NET <see cref="Exception"/> associated with the <see cref="Win32Error"/> value and optionally adds the supplied message.
|
||||
/// </summary>
|
||||
/// <param name="message">The optional message to assign to the <see cref="Exception"/>.</param>
|
||||
/// <returns>The associated <see cref="Exception"/> or <see langword="null"/> if this <see cref="Win32Error"/> is not a failure.</returns>
|
||||
[SecurityCritical, SecuritySafeCritical]
|
||||
public Exception GetException(string message = null) => Succeeded ? null : ToHRESULT().GetException(message);
|
||||
|
||||
/// <summary>Returns a hash code for this instance.</summary>
|
||||
/// <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
|
||||
public override int GetHashCode() => unchecked((int)value);
|
||||
|
||||
/// <summary>Throws if failed.</summary>
|
||||
/// <param name="message">The message.</param>
|
||||
/// <exception cref="Win32Exception"></exception>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public void ThrowIfFailed(string message = null)
|
||||
{
|
||||
if (value != ERROR_SUCCESS) throw GetException(message);
|
||||
}
|
||||
|
||||
/// <summary>Throws if failed, unless the error is the specified value.</summary>
|
||||
/// <param name="exception">The failure code to ignore.</param>
|
||||
/// <param name="message">The message.</param>
|
||||
[System.Diagnostics.DebuggerStepThrough]
|
||||
public void ThrowUnless(Win32Error exception, string message = null)
|
||||
{
|
||||
if (value != ERROR_SUCCESS && value != (uint)exception) throw GetException(message);
|
||||
}
|
||||
|
||||
/// <summary>Converts this error to an <see cref="HRESULT"/>.</summary>
|
||||
/// <returns>The <see cref="HRESULT"/> equivalent of this error.</returns>
|
||||
public HRESULT ToHRESULT() => (HRESULT)this;
|
||||
|
||||
/// <summary>Returns a <see cref="string"/> that represents this instance.</summary>
|
||||
/// <returns>A <see cref="string"/> that represents this instance.</returns>
|
||||
public override string ToString()
|
||||
{
|
||||
_=StaticFieldValueHash.TryGetFieldName<Win32Error, uint>(value, out var err);
|
||||
var msg = HRESULT.FormatMessage(value);
|
||||
return (err ?? string.Format(CultureInfo.InvariantCulture, "0x{0:X8}", value)) + (msg == null ? "" : ": " + msg);
|
||||
}
|
||||
|
||||
TypeCode IConvertible.GetTypeCode() => value.GetTypeCode();
|
||||
|
||||
bool IConvertible.ToBoolean(IFormatProvider provider) => Succeeded;
|
||||
|
||||
byte IConvertible.ToByte(IFormatProvider provider) => ((IConvertible)value).ToByte(provider);
|
||||
|
||||
char IConvertible.ToChar(IFormatProvider provider) => throw new NotSupportedException();
|
||||
|
||||
DateTime IConvertible.ToDateTime(IFormatProvider provider) => throw new NotSupportedException();
|
||||
|
||||
decimal IConvertible.ToDecimal(IFormatProvider provider) => ((IConvertible)value).ToDecimal(provider);
|
||||
|
||||
double IConvertible.ToDouble(IFormatProvider provider) => ((IConvertible)value).ToDouble(provider);
|
||||
|
||||
short IConvertible.ToInt16(IFormatProvider provider) => ((IConvertible)value).ToInt16(provider);
|
||||
|
||||
int IConvertible.ToInt32(IFormatProvider provider) => ((IConvertible)value).ToInt32(provider);
|
||||
|
||||
long IConvertible.ToInt64(IFormatProvider provider) => ((IConvertible)value).ToInt64(provider);
|
||||
|
||||
sbyte IConvertible.ToSByte(IFormatProvider provider) => ((IConvertible)value).ToSByte(provider);
|
||||
|
||||
float IConvertible.ToSingle(IFormatProvider provider) => ((IConvertible)value).ToSingle(provider);
|
||||
|
||||
string IConvertible.ToString(IFormatProvider provider) => ToString();
|
||||
|
||||
object IConvertible.ToType(Type conversionType, IFormatProvider provider) =>
|
||||
((IConvertible)value).ToType(conversionType, provider);
|
||||
|
||||
ushort IConvertible.ToUInt16(IFormatProvider provider) => ((IConvertible)value).ToUInt16(provider);
|
||||
|
||||
uint IConvertible.ToUInt32(IFormatProvider provider) => ((IConvertible)value).ToUInt32(provider);
|
||||
|
||||
ulong IConvertible.ToUInt64(IFormatProvider provider) => ((IConvertible)value).ToUInt64(provider);
|
||||
|
||||
[DllImport(Lib.Kernel32, SetLastError = false, EntryPoint = "GetLastError")]
|
||||
private static extern uint ExtGetLastError();
|
||||
|
||||
private static uint? ValueFromObj(object obj)
|
||||
{
|
||||
if (obj == null) return null;
|
||||
TypeConverter c = TypeDescriptor.GetConverter(obj);
|
||||
return c.CanConvertTo(typeof(uint)) ? (uint?)c.ConvertTo(obj, typeof(uint)) : null;
|
||||
}
|
||||
}
|
||||
|
||||
internal class Win32ErrorTypeConverter : TypeConverter
|
||||
{
|
||||
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) =>
|
||||
sourceType.IsPrimitive && sourceType != typeof(bool) && sourceType != typeof(char) || base.CanConvertFrom(context, sourceType);
|
||||
|
||||
public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType) =>
|
||||
destinationType == typeof(string) || destinationType.IsPrimitive && destinationType != typeof(char) || base.CanConvertTo(context, destinationType);
|
||||
|
||||
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) =>
|
||||
value != null && value.GetType().IsPrimitive && value is not char && value is not bool
|
||||
? new Win32Error((uint)Convert.ChangeType(value, TypeCode.UInt32))
|
||||
: base.ConvertFrom(context, culture, value);
|
||||
|
||||
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)
|
||||
{
|
||||
if (value is not Win32Error err) throw new NotSupportedException();
|
||||
if (destinationType.IsPrimitive && destinationType != typeof(char))
|
||||
return Convert.ChangeType(err, destinationType);
|
||||
return destinationType == typeof(string) ? err.ToString() : base.ConvertTo(context, culture, value, destinationType);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue