winsafe 0.0.27

Windows API and GUI in safe, idiomatic Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

#![allow(non_camel_case_types, non_snake_case)]

use std::mem::ManuallyDrop;

use crate::co;
use crate::decl::*;
use crate::guard::*;
use crate::kernel::privs::*;
use crate::user::ffi;

handle! { HDESK;
	/// Handle to a
	/// [desktop](https://learn.microsoft.com/en-us/windows/win32/winprog/windows-data-types#hdesk).
}

impl HDESK {
	/// [`CreateDesktop`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createdesktopw)
	/// function.
	#[must_use]
	pub fn CreateDesktop(
		name: &str,
		flags: Option<co::DF>,
		desired_access: co::DESKTOP_RIGHTS,
		security_attributes: Option<&SECURITY_ATTRIBUTES>,
	) -> SysResult<CloseDesktopGuard> {
		unsafe {
			PtrRet(ffi::CreateDesktopW(
				WString::from_str(name).as_ptr(),
				std::ptr::null(),
				std::ptr::null(),
				flags.unwrap_or_default().raw(),
				desired_access.raw(),
				pcvoid_or_null(security_attributes),
			))
			.to_sysresult_handle()
			.map(|h| CloseDesktopGuard::new(h))
		}
	}

	/// [`CreateDesktopEx`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createdesktopexw)
	/// function.
	#[must_use]
	pub fn CreateDesktopEx(
		name: &str,
		flags: Option<co::DF>,
		desired_access: co::DESKTOP_RIGHTS,
		security_attributes: Option<&SECURITY_ATTRIBUTES>,
		heap_size_kb: u32,
	) -> SysResult<CloseDesktopGuard> {
		unsafe {
			PtrRet(ffi::CreateDesktopExW(
				WString::from_str(name).as_ptr(),
				std::ptr::null(),
				std::ptr::null(),
				flags.unwrap_or_default().raw(),
				desired_access.raw(),
				pcvoid_or_null(security_attributes),
				heap_size_kb,
				std::ptr::null_mut(),
			))
			.to_sysresult_handle()
			.map(|h| CloseDesktopGuard::new(h))
		}
	}

	/// [`GetThreadDesktop`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getthreaddesktop)
	/// function.
	///
	/// # Examples
	///
	/// ```no_run
	/// use winsafe::{self as w, prelude::*};
	///
	/// let hdesk = w::HDESK::GetThreadDesktop(w::GetCurrentThreadId())?;
	/// # w::SysResult::Ok(())
	#[must_use]
	pub fn GetThreadDesktop(thread_id: u32) -> SysResult<ManuallyDrop<CloseDesktopGuard>> {
		unsafe {
			PtrRet(ffi::GetThreadDesktop(thread_id))
				.to_sysresult_handle()
				.map(|h| ManuallyDrop::new(CloseDesktopGuard::new(h)))
		}
	}

	/// [`OpenDesktop`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-opendesktopw)
	/// function.
	#[must_use]
	pub fn OpenDesktop(
		name: &str,
		flags: Option<co::DF>,
		inherit: bool,
		desired_access: co::DESKTOP_RIGHTS,
	) -> SysResult<CloseDesktopGuard> {
		unsafe {
			PtrRet(ffi::OpenDesktopW(
				WString::from_str(name).as_ptr(),
				flags.unwrap_or_default().raw(),
				inherit as _,
				desired_access.raw(),
			))
			.to_sysresult_handle()
			.map(|h| CloseDesktopGuard::new(h))
		}
	}

	/// [`OpenInputDesktop`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-openinputdesktop)
	/// function.
	#[must_use]
	pub fn OpenInputDesktop(
		flags: Option<co::DF>,
		inherit: bool,
		desired_access: co::DESKTOP_RIGHTS,
	) -> SysResult<CloseDesktopGuard> {
		unsafe {
			PtrRet(ffi::OpenInputDesktop(
				flags.unwrap_or_default().raw(),
				inherit as _,
				desired_access.raw(),
			))
			.to_sysresult_handle()
			.map(|h| CloseDesktopGuard::new(h))
		}
	}

	/// [`SetThreadDesktop`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-setthreaddesktop)
	/// function.
	pub fn SetThreadDesktop(&self) -> SysResult<()> {
		BoolRet(unsafe { ffi::SetThreadDesktop(self.ptr()) }).to_sysresult()
	}

	/// [`SwitchDesktop`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-switchdesktop)
	/// function.
	pub fn SwitchDesktop(&self) -> SysResult<()> {
		BoolRet(unsafe { ffi::SwitchDesktop(self.ptr()) }).to_sysresult()
	}
}