Add comment about GetConsoleMode's return value

colored-rs · Jul 6, 2023 · 81bf1c5 · 81bf1c5
1 parent 24e44fd
commit 81bf1c5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/control.rs b/src/control.rs
@@ -41,7 +41,10 @@ pub fn set_virtual_terminal(use_virtual: bool) -> Result<(), ()> {
         }
 
         let mut original_mode: DWORD = 0;
+        // Return value of 0 means that the function failed:
+        // https://learn.microsoft.com/en-us/windows/console/getconsolemode#return-value
         if GetConsoleMode(handle, &mut original_mode) == 0 {
+            // TODO: It would be prudent to get the error using `GetLastError` here.
             return Err(());
         }