Add a helper function for formatting Win32 error messages

itm4n · Dec 30, 2024 · 307c183 · 307c183
1 parent a39a424
commit 307c183
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/src/helper/Utility.ps1 b/src/helper/Utility.ps1
@@ -1,3 +1,22 @@
+function Format-Error {
+
+    [OutputType([String])]
+    [CmdletBinding()]
+    param (
+        [Parameter(Position=0, Mandatory=$true)]
+        [ValidateNotNullOrEmpty()]
+        [Int32] $Code
+    )
+
+    process {
+        $ErrorObject = [ComponentModel.Win32Exception] $Code
+        $ErrorMessage = "$($ErrorObject.Message)"
+        if ($ErrorObject.NativeErrorCode -ge 0) { $ErrorMessage += " ($($ErrorObject.NativeErrorCode))" }
+        $ErrorMessage += " - HRESULT: $('0x{0:x8}' -f $ErrorObject.HResult)"
+        return $ErrorMessage
+    }
+}
+
 function Get-InitialSessionState {
 
     [OutputType([Management.Automation.Runspaces.InitialSessionState])]