Generated missing API docs

nefarius · Jul 7, 2024 · c40bedf · c40bedf
1 parent 00144e9
commit c40bedf
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -53,3 +53,7 @@
 - [PnPDevice](./nefarius.utilities.devicemanagement.pnp.pnpdevice.md)
 
 - [UsbPnPDevice](./nefarius.utilities.devicemanagement.pnp.usbpnpdevice.md)
+
+## Namespace Nefarius.Utilities.DeviceManagement.Util
+
+- [NtStatusUtil](./nefarius.utilities.devicemanagement.util.ntstatusutil.md)
diff --git a/docs/nefarius.utilities.devicemanagement.exceptions.win32exception.md b/docs/nefarius.utilities.devicemanagement.exceptions.win32exception.md
@@ -116,3 +116,22 @@ public MethodBase TargetSite { get; }
 #### Property Value
 
 [MethodBase](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.methodbase)<br>
+
+## Methods
+
+### <a id="methods-getmessagefor"/>**GetMessageFor(Nullable&lt;Int32&gt;)**
+
+Translates a Win32 error code to the user-readable message.
+
+```csharp
+public static string GetMessageFor(Nullable<Int32> errorCode)
+```
+
+#### Parameters
+
+`errorCode` [Nullable&lt;Int32&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.nullable-1)<br>
+The Win32 error code. Gets fetched from [Marshal.GetLastWin32Error()](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.marshal.getlastwin32error) if null.
+
+#### Returns
+
+The message, if any, or null.
diff --git a/docs/nefarius.utilities.devicemanagement.util.ntstatusutil.md b/docs/nefarius.utilities.devicemanagement.util.ntstatusutil.md
@@ -0,0 +1,34 @@
+# NtStatusUtil
+
+Namespace: Nefarius.Utilities.DeviceManagement.Util
+
+Utility methods for handling NTSTATUS values.
+
+```csharp
+public static class NtStatusUtil
+```
+
+Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [NtStatusUtil](./nefarius.utilities.devicemanagement.util.ntstatusutil.md)
+
+## Methods
+
+### <a id="methods-convertntstatustowin32error"/>**ConvertNtStatusToWin32Error(UInt32)**
+
+Converts an NTSTATUS value to a [WIN32_ERROR](./windows.win32.foundation.win32_error.md).
+
+```csharp
+public static int ConvertNtStatusToWin32Error(uint ntStatus)
+```
+
+#### Parameters
+
+`ntStatus` [UInt32](https://docs.microsoft.com/en-us/dotnet/api/system.uint32)<br>
+The NTSTATUS value to convert.
+
+#### Returns
+
+The converted Win32 error code.
+
+**Remarks:**
+
+https://stackoverflow.com/a/32205631