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

#![allow(non_camel_case_types, non_snake_case)]

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

handle! { HINTERNET;
	/// Root
	/// [Internet](https://learn.microsoft.com/en-us/windows/win32/wininet/appendix-a-hinternet-handles)
	/// handle.
}

impl HINTERNET {
	/// [`InternetConnect`](https://learn.microsoft.com/en-us/windows/win32/api/wininet/nf-wininet-internetconnectw)
	/// function.
	#[must_use]
	pub fn InternetConnect(
		&self,
		server_name: &str,
		server_port: co::INTERNET_DEFAULT_PORT,
		user_name: Option<&str>,
		password: Option<&str>,
		service: co::INTERNET_SERVICE,
		flags: co::INTERNET_FLAG,
		context: Option<isize>,
	) -> SysResult<InternetCloseHandleGuard<HINTERNETSESSION>> {
		unsafe {
			PtrRet(ffi::InternetConnectW(
				self.ptr(),
				WString::from_str(server_name).as_ptr(),
				server_port.raw(),
				WString::from_opt_str(user_name).as_ptr(),
				WString::from_opt_str(password).as_ptr(),
				service.raw(),
				flags.raw(),
				context.unwrap_or_default(),
			))
			.to_sysresult_handle()
			.map(|h| InternetCloseHandleGuard::new(h))
		}
	}

	/// [`InternetOpen`](https://learn.microsoft.com/en-us/windows/win32/api/wininet/nf-wininet-internetopenw)
	/// function.
	#[must_use]
	pub fn InternetOpen(
		agent: &str,
		access_type: co::INTERNET_OPEN_TYPE,
		proxy: Option<&str>,
		proxy_bypass: Option<&str>,
		flags: co::INTERNET_FLAG,
	) -> SysResult<InternetCloseHandleGuard<HINTERNET>> {
		unsafe {
			PtrRet(ffi::InternetOpenW(
				WString::from_str(agent).as_ptr(),
				access_type.raw(),
				WString::from_opt_str(proxy).as_ptr(),
				WString::from_opt_str(proxy_bypass).as_ptr(),
				flags.raw(),
			))
			.to_sysresult_handle()
			.map(|h| InternetCloseHandleGuard::new(h))
		}
	}

	/// [`InternetOpenUrl`](https://learn.microsoft.com/en-us/windows/win32/api/wininet/nf-wininet-internetopenurlw)
	/// function.
	///
	/// It's a good idea to pass `url` through
	/// [`InternetCanonicalizeUrl`](crate::InternetCanonicalizeUrl) before
	/// calling this function.
	#[must_use]
	pub fn InternetOpenUrl(
		&self,
		url: &str,
		headers: Option<&str>,
		flags: co::INTERNET_FLAG,
		context: Option<isize>,
	) -> SysResult<InternetCloseHandleGuard<HINTERNETREQUEST>> {
		let wheaders = WString::from_opt_str(headers);
		unsafe {
			PtrRet(ffi::InternetOpenUrlW(
				self.ptr(),
				WString::from_str(url).as_ptr(),
				wheaders.as_ptr(),
				wheaders.str_len() as _,
				flags.raw(),
				context.unwrap_or_default(),
			))
			.to_sysresult_handle()
			.map(|h| InternetCloseHandleGuard::new(h))
		}
	}
}