HResultHelper Class

[This is preliminary documentation and is subject to change.]

Helper class to create and examine custom HResult values.

Inheritance Hierarchy

SystemObject
NerdyDuck.CodedExceptionsHResultHelper

Namespace: NerdyDuck.CodedExceptions
Assembly: NerdyDuck.CodedExceptions (in NerdyDuck.CodedExceptions.dll) Version: 2.0.0+2040dad

Syntax

public static class HResultHelper

Public NotInheritable Class HResultHelper

The HResultHelper type exposes the following members.

Methods

	Name	Description
	CreateToString	Creates the default ToString implementation for CodedExceptions, with the optional addition of custom text.
	EnumToInt32	Returns the integer value of an enumeration value.
	GetBaseHResult	Gets the HRESULT base value for the specified facility identifier.
	GetErrorId	Gets the error identifier part of an HResult.
	GetFacilityId	Gets the facility (= the assembly) identifier part of an HResult.
	HexStringToByteArray	Converts a string of hexadecimal values into a byte array.
	IsCustomHResult	Checks if the specified HRESULT is a custom error value.

Fields

	Name	Description
	CustomHResultMask	A bit mask to check if the HResult is a custom value.
	ErrorIdMask	A bit mask to filter the error id of the HResult.
	FacilityIdMask	A bit mask to filter the id of the facility (= the assembly) that threw the exception.
	FacilityIdShift	The number of bits to shift an HResult to the left to get the facility (= the assembly) id on the lowest bit.
	HResultBase	The base value for all custom HRESULT values, to unambiguously distinguish the exceptions from Microsoft error codes.

Remarks

See the HRESULT definition at MSDN for more information about the definition of HRESULT values.