HRESULT.cs

// Copyright (c) Files Community
// Licensed under the MIT License.

using System.Diagnostics;
using System.Runtime.InteropServices;

namespace Windows.Win32.Foundation
{
	[DebuggerDisplay("{" + nameof(Value) + ",h}")]
	public readonly partial struct HRESULT
	{
		/// <summary>
		/// Throws an exception if the <see cref="HRESULT"/> indicates a failure in debug mode. Otherwise, it returns the original <see cref="HRESULT"/>.
		/// </summary>
		/// <returns>Returns the original <see cref="HRESULT"/> value regardless of the operation's success.</returns>
		public readonly HRESULT ThrowIfFailedOnDebug()
		{
#if DEBUG
			if (Failed) Marshal.ThrowExceptionForHR(Value);
#endif

			return this;
		}

		// #define E_NOT_SET HRESULT_FROM_WIN32(ERROR_NOT_FOUND)
		public static readonly HRESULT E_NOT_SET = (HRESULT)(-2147023728);
	}
}