Added IErrorProvider as equatable for HRESULT

pull/303/head
dahall 2022-06-28 15:04:13 -06:00
parent 47b609765d
commit 5bf2fce31e
1 changed files with 36 additions and 10 deletions

View File

@ -41,7 +41,7 @@ namespace Vanara.PInvoke
[StructLayout(LayoutKind.Sequential)] [StructLayout(LayoutKind.Sequential)]
[TypeConverter(typeof(HRESULTTypeConverter))] [TypeConverter(typeof(HRESULTTypeConverter))]
[PInvokeData("winerr.h")] [PInvokeData("winerr.h")]
public partial struct HRESULT : IComparable, IComparable<HRESULT>, IEquatable<HRESULT>, IEquatable<int>, IEquatable<uint>, IConvertible, IErrorProvider public partial struct HRESULT : IComparable, IComparable<HRESULT>, IEquatable<HRESULT>, IEquatable<int>, IEquatable<uint>, IEquatable<IErrorProvider>, IConvertible, IErrorProvider
{ {
internal readonly int _value; internal readonly int _value;
@ -535,12 +535,12 @@ namespace Vanara.PInvoke
/// <summary>Performs an implicit conversion from <see cref="System.Int32"/> to <see cref="HRESULT"/>.</summary> /// <summary>Performs an implicit conversion from <see cref="System.Int32"/> to <see cref="HRESULT"/>.</summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The result of the conversion.</returns> /// <returns>The result of the conversion.</returns>
public static implicit operator HRESULT(int value) => new HRESULT(value); public static implicit operator HRESULT(int value) => new(value);
/// <summary>Performs an implicit conversion from <see cref="System.UInt32"/> to <see cref="HRESULT"/>.</summary> /// <summary>Performs an implicit conversion from <see cref="System.UInt32"/> to <see cref="HRESULT"/>.</summary>
/// <param name="value">The value.</param> /// <param name="value">The value.</param>
/// <returns>The resulting <see cref="HRESULT"/> instance from the conversion.</returns> /// <returns>The resulting <see cref="HRESULT"/> instance from the conversion.</returns>
public static implicit operator HRESULT(uint value) => new HRESULT(value); public static implicit operator HRESULT(uint value) => new(value);
/// <summary>Maps an NT Status value to an HRESULT value.</summary> /// <summary>Maps an NT Status value to an HRESULT value.</summary>
/// <param name="err">The NT Status value.</param> /// <param name="err">The NT Status value.</param>
@ -565,7 +565,7 @@ namespace Vanara.PInvoke
/// <param name="code">The code.</param> /// <param name="code">The code.</param>
/// <returns>The resulting <see cref="HRESULT"/>.</returns> /// <returns>The resulting <see cref="HRESULT"/>.</returns>
public static HRESULT Make(bool severe, uint facility, uint code) => public static HRESULT Make(bool severe, uint facility, uint code) =>
new HRESULT(unchecked((int)((severe ? severityMask : 0) | (facility << facilityShift) | code))); new(unchecked((int)((severe ? severityMask : 0) | (facility << facilityShift) | code)));
/// <summary>Implements the operator !=.</summary> /// <summary>Implements the operator !=.</summary>
/// <param name="hrLeft">The first <see cref="HRESULT"/>.</param> /// <param name="hrLeft">The first <see cref="HRESULT"/>.</param>
@ -585,6 +585,12 @@ namespace Vanara.PInvoke
/// <returns>The result of the operator.</returns> /// <returns>The result of the operator.</returns>
public static bool operator !=(HRESULT hrLeft, uint hrRight) => !(hrLeft == hrRight); public static bool operator !=(HRESULT hrLeft, uint hrRight) => !(hrLeft == hrRight);
/// <summary>Implements the operator ==.</summary>
/// <param name="hrLeft">The first <see cref="HRESULT"/>.</param>
/// <param name="hrRight">The second <see cref="IErrorProvider"/>.</param>
/// <returns>The result of the operator.</returns>
public static bool operator !=(HRESULT hrLeft, IErrorProvider hrRight) => !hrLeft.Equals(hrRight.ToHRESULT());
/// <summary>Implements the operator ==.</summary> /// <summary>Implements the operator ==.</summary>
/// <param name="hrLeft">The first <see cref="HRESULT"/>.</param> /// <param name="hrLeft">The first <see cref="HRESULT"/>.</param>
/// <param name="hrRight">The second <see cref="HRESULT"/>.</param> /// <param name="hrRight">The second <see cref="HRESULT"/>.</param>
@ -603,6 +609,21 @@ namespace Vanara.PInvoke
/// <returns>The result of the operator.</returns> /// <returns>The result of the operator.</returns>
public static bool operator ==(HRESULT hrLeft, uint hrRight) => hrLeft.Equals(hrRight); public static bool operator ==(HRESULT hrLeft, uint hrRight) => hrLeft.Equals(hrRight);
/// <summary>Implements the operator ==.</summary>
/// <param name="hrLeft">The first <see cref="HRESULT"/>.</param>
/// <param name="hrRight">The second <see cref="IErrorProvider"/>.</param>
/// <returns>The result of the operator.</returns>
public static bool operator ==(HRESULT hrLeft, IErrorProvider hrRight) => hrLeft.Equals(hrRight.ToHRESULT());
/// <summary>
/// If the supplied raw HRESULT value represents a failure, throw the associated <see cref="Exception"/> with the optionally
/// supplied message.
/// </summary>
/// <param name="hresult">The 32-bit raw HRESULT value.</param>
/// <param name="message">The optional message to assign to the <see cref="Exception"/>.</param>
[System.Diagnostics.DebuggerStepThrough]
public static void ThrowIfFailed(HRESULT hresult, string message = null) => hresult.ThrowIfFailed(message);
/// <summary> /// <summary>
/// If the supplied raw HRESULT value represents a failure, throw the associated <see cref="Exception"/> with the optionally /// If the supplied raw HRESULT value represents a failure, throw the associated <see cref="Exception"/> with the optionally
/// supplied message. /// supplied message.
@ -649,6 +670,11 @@ namespace Vanara.PInvoke
/// <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns> /// <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
public bool Equals(uint other) => unchecked((int)other) == _value; public bool Equals(uint other) => unchecked((int)other) == _value;
/// <summary>Indicates whether the current object is equal to an <see cref="uint"/>.</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>
public bool Equals(IErrorProvider other) => Equals(other.ToHRESULT());
/// <summary>Determines whether the specified <see cref="object"/>, is equal to this instance.</summary> /// <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> /// <param name="obj">The <see cref="object"/> to compare with this instance.</param>
/// <returns><c>true</c> if the specified <see cref="object"/> is equal to this instance; otherwise, <c>false</c>.</returns> /// <returns><c>true</c> if the specified <see cref="object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
@ -658,6 +684,7 @@ namespace Vanara.PInvoke
HRESULT h => Equals(h), HRESULT h => Equals(h),
int i => Equals(i), int i => Equals(i),
uint u => Equals(u), uint u => Equals(u),
IErrorProvider e => Equals(e),
_ => Equals(_value, ValueFromObj(obj)), _ => Equals(_value, ValueFromObj(obj)),
}; };
@ -715,9 +742,8 @@ namespace Vanara.PInvoke
/// <returns>A <see cref="string"/> that represents this instance.</returns> /// <returns>A <see cref="string"/> that represents this instance.</returns>
public override string ToString() public override string ToString()
{ {
string err = null;
// Check for defined HRESULT value // Check for defined HRESULT value
if (!StaticFieldValueHash.TryGetFieldName<HRESULT, int>(_value, out err) && Facility == FacilityCode.FACILITY_WIN32) if (!StaticFieldValueHash.TryGetFieldName<HRESULT, int>(_value, out var err) && Facility == FacilityCode.FACILITY_WIN32)
{ {
foreach (var info2 in typeof(Win32Error).GetFields(BindingFlags.Public | BindingFlags.Static).Where(fi => fi.FieldType == typeof(uint))) foreach (var info2 in typeof(Win32Error).GetFields(BindingFlags.Public | BindingFlags.Static).Where(fi => fi.FieldType == typeof(uint)))
{ {
@ -819,7 +845,7 @@ namespace Vanara.PInvoke
{ {
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
{ {
if (sourceType == typeof(Win32Error) || sourceType.IsPrimitive && sourceType != typeof(char)) if (sourceType is IErrorProvider || sourceType.IsPrimitive && sourceType != typeof(char))
return true; return true;
return base.CanConvertFrom(context, sourceType); return base.CanConvertFrom(context, sourceType);
} }
@ -833,13 +859,13 @@ namespace Vanara.PInvoke
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
{ {
if (value is Win32Error e) if (value is IErrorProvider e)
return e.ToHRESULT(); return e.ToHRESULT();
if (value != null && value.GetType().IsPrimitive) if (value != null && value.GetType().IsPrimitive)
{ {
if (value is bool b) if (value is bool b)
return b ? HRESULT.S_OK : HRESULT.S_FALSE; return b ? HRESULT.S_OK : HRESULT.S_FALSE;
if (!(value is char)) if (value is not char)
return new HRESULT((int)Convert.ChangeType(value, TypeCode.Int32)); return new HRESULT((int)Convert.ChangeType(value, TypeCode.Int32));
} }
return base.ConvertFrom(context, culture, value); return base.ConvertFrom(context, culture, value);
@ -848,7 +874,7 @@ namespace Vanara.PInvoke
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value,
Type destinationType) Type destinationType)
{ {
if (!(value is HRESULT hr)) throw new NotSupportedException(); if (value is not HRESULT hr) throw new NotSupportedException();
if (destinationType.IsPrimitive && destinationType != typeof(char)) if (destinationType.IsPrimitive && destinationType != typeof(char))
return Convert.ChangeType(hr, destinationType); return Convert.ChangeType(hr, destinationType);
if (destinationType == typeof(string)) if (destinationType == typeof(string))