docs: add documentation for get_windows_build_number function

- Added concise documentation for the `get_windows_build_number` function, explaining its purpose, return value, and safety considerations.
This commit is contained in:
joaoviictorti
2024-09-27 21:08:42 -03:00
parent f71555748c
commit 990af53343

View File

@@ -490,11 +490,12 @@ where
result // Returns the result of the operation
}
/// Retrieves the Windows build number by calling `RtlGetVersion`.
///
/// # Return
///
/// - `u32`: The Windows build number if successful, otherwise returns 0.
///
///
///
///
///
pub fn get_windows_build_number() -> u32 {
unsafe {
let mut os_info: OSVERSIONINFOW = core::mem::zeroed();