🧑‍💻 Reserve operating system status codes #103

Author: xecrets

sdk-docs/Xecrets.Sdk.XfSdkVersion.md

@@ -17,10 +17,10 @@ Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.O
 ## XfSdkVersion.SdkVersion Property
 
 The API version is to be updated when the command line options are updated in an incompatible way. The minor  
-version is increased if changes do not change the meaning or syntax of any pre-existing options, i.e. purely  
-new additional capabilities. The major version is increased if changes in any way changes an existing option  
-so it may not work as expected by an older consumer. The consumer should thus only accept an export version  
-that has the same Major version, and a minor version greather than or equal to it's known version.
+version is increased if changes do not change the meaning or syntax of any pre-existing options, i.e. purely new  
+additional capabilities. The major version is increased if changes in any way changes an existing option so it  
+may not work as expected by an older consumer. The consumer should thus only accept an export version that has  
+the same Major version, and a minor version greather than or equal to it's known version.
 
 ```csharp
 public static System.Version SdkVersion { get; }
@@ -30,7 +30,8 @@ public static System.Version SdkVersion { get; }
 [System.Version](https://docs.microsoft.com/en-us/dotnet/api/System.Version 'System.Version')
 
 ### Remarks
-Changes includes not only syntax and semantics, but also actual numerical values assigned to <seealso cref="T:Xecrets.Sdk.Cli.XfOpCode"/> and <seealso cref="T:Xecrets.Sdk.Cli.XfCliApi"/> as well as changes or removals of json property names in  
+Changes includes not only syntax and semantics, but also actual numerical values assigned to <seealso cref="T:Xecrets.Sdk.Cli.XfOpCode"/>, <seealso cref="T:Xecrets.Sdk.Cli.XfStatusCode"> and </seealso>and <seealso cref="T:Xecrets.Sdk.Cli.XfCliApi"/> as well as changes  
+or removals of json property names in  
 <seealso cref="T:Xecrets.Sdk.Cli.CliMessage"/> .
 ### Methods
 

src/Xecrets.Cli/Public/XfExportVersion.cs

@@ -49,6 +49,7 @@ public static class XfExportVersion
     /// 4.0 -> 2024-12-16 Add --work-folder and change meaning of --cli-crash-log
     /// 4.1 -> 2024-12-19 Add --crash
     /// 5.0 -> 2024-12-28 Rename some options to clarify syntax, i.e. encrypt-to -> encrypt-from-to etc.
+    /// 6.0 -> 2025-01-16 Add operating system status return codes
     /// </remarks>
-    public static Version CliVersion => new(5, 0);
+    public static Version CliVersion => new(6, 0);
 }

src/Xecrets.Cli/Public/XfStatusCode.cs

@@ -38,44 +38,59 @@ public enum XfStatusCode
 {
     Success = 0,
 
-    AxCryptException = 3,
-    BadSequence = 6,
-    Canceled = 9,
-    CannotDelete = 12,
-    CannotRead = 15,
-    CannotWrite = 18,
-    CliToolIncompatible = 21,
-    CliToolNotFound = 24,
-    DebugBreakFailed = 27,
-    DeserializeError = 30,
-    Error = 33,
-    ExceptionError = 36,
-    ExtraArguments = 39,
-    FileUnavailable = 42,
-    InternalError = 45,
-    InternalUnexpectedAction = 48,
-    InternalUnknownStatus = 51,
-    InvalidDays = 54,
-    InvalidEmail = 57,
-    InvalidLicenseFormat = 60,
-    InvalidLicenseSignature = 63,
-    InvalidOption = 66,
-    InvalidPassword = 69,
-    InvalidToken = 72,
-    LockedInUse = 75,
-    MissingArgument = 78,
-    NoDryRun = 81,
-    NoPassword = 84,
-    NotAFile = 87,
-    NotAFolder = 90,
-    NotSupported = 93,
-    NotWritable = 96,
-    NotYetImplemented = 99,
-    PublicKeyNotFound = 102,
-    Slip39Error = 105,
-    UnhandledOperationException = 108,
-    UnhandledRunException = 111,
-    UnknownEnvironmentVariable = 114,
-    UnknownOption = 117,
-    Unlicensed = 120,
+    OsFileNotFound = 2, // 0x02
+    OsPathNotFound = 3, // 0x03
+    OsTooManyOpenFiles = 4, // 0x04
+    OsAccessDenied = 5, // 0x05
+    OsNotEnoughMemory = 8, // 0x08
+    OsBadFormat = 11, // 0x0b
+    OsInvalidData = 13, // 0x0d
+    OsOutOfMemory = 14, // 0x0e
+    OsNetOutOfMemory = 23, // 0x17
+    OsIllegalInstruction = 29, // 0x1d
+    OsSharingViolation = 32, // 0x20
+    OsLockViolation = 33, // 0x21
+    OsBadImageFormat = 123, // 0x7b
+    OsStackOverflow = 253, // 0xfd
+
+    AxCryptException = 6,
+    BadSequence = 9,
+    Canceled = 12,
+    CannotDelete = 15,
+    CannotRead = 18,
+    CannotWrite = 21,
+    CliToolIncompatible = 24,
+    CliToolNotFound = 27,
+    DebugBreakFailed = 30,
+    DeserializeError = 36,
+    Error = 39,
+    ExceptionError = 42,
+    ExtraArguments = 45,
+    FileUnavailable = 48,
+    InternalError = 51,
+    InternalUnexpectedAction = 54,
+    InternalUnknownStatus = 57,
+    InvalidDays = 60,
+    InvalidEmail = 63,
+    InvalidLicenseFormat = 66,
+    InvalidLicenseSignature = 69,
+    InvalidOption = 72,
+    InvalidPassword = 75,
+    InvalidToken = 78,
+    LockedInUse = 81,
+    MissingArgument = 84,
+    NoDryRun = 87,
+    NoPassword = 90,
+    NotAFile = 93,
+    NotAFolder = 96,
+    NotSupported = 99,
+    NotWritable = 102,
+    NotYetImplemented = 105,
+    PublicKeyNotFound = 108,
+    Slip39Error = 111,
+    UnhandledOperationException = 114,
+    UnhandledRunException = 117,
+    UnknownEnvironmentVariable = 120,
+    UnknownOption = 126,
+    Unlicensed = 127,
 }