2 * Copyright 2010 Vicente J. Botet Escriba
3 * Copyright 2015, 2017 Andrey Semashev
5 * Distributed under the Boost Software License, Version 1.0.
6 * See http://www.boost.org/LICENSE_1_0.txt
9 #ifndef BOOST_WINAPI_EVENT_HPP_INCLUDED_
10 #define BOOST_WINAPI_EVENT_HPP_INCLUDED_
12 #include <boost/winapi/basic_types.hpp>
13 #include <boost/winapi/detail/header.hpp>
15 #ifdef BOOST_HAS_PRAGMA_ONCE
19 #if !defined( BOOST_USE_WINDOWS_H ) && BOOST_WINAPI_PARTITION_APP_SYSTEM
21 #if !defined( BOOST_NO_ANSI_APIS )
22 BOOST_WINAPI_IMPORT boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
24 ::_SECURITY_ATTRIBUTES* lpEventAttributes,
25 boost::winapi::BOOL_ bManualReset,
26 boost::winapi::BOOL_ bInitialState,
27 boost::winapi::LPCSTR_ lpName);
30 BOOST_WINAPI_IMPORT_EXCEPT_WM boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
32 ::_SECURITY_ATTRIBUTES* lpEventAttributes,
33 boost::winapi::BOOL_ bManualReset,
34 boost::winapi::BOOL_ bInitialState,
35 boost::winapi::LPCWSTR_ lpName);
37 #endif // !defined( BOOST_USE_WINDOWS_H ) && BOOST_WINAPI_PARTITION_APP_SYSTEM
39 #if !defined( BOOST_USE_WINDOWS_H )
41 #if !defined( BOOST_NO_ANSI_APIS )
42 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
43 BOOST_WINAPI_IMPORT boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
45 ::_SECURITY_ATTRIBUTES *lpEventAttributes,
46 boost::winapi::LPCSTR_ lpName,
47 boost::winapi::DWORD_ dwFlags,
48 boost::winapi::DWORD_ dwDesiredAccess);
51 BOOST_WINAPI_IMPORT boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
53 boost::winapi::DWORD_ dwDesiredAccess,
54 boost::winapi::BOOL_ bInheritHandle,
55 boost::winapi::LPCSTR_ lpName);
56 #endif // !defined( BOOST_NO_ANSI_APIS )
58 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
59 BOOST_WINAPI_IMPORT boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
61 ::_SECURITY_ATTRIBUTES *lpEventAttributes,
62 boost::winapi::LPCWSTR_ lpName,
63 boost::winapi::DWORD_ dwFlags,
64 boost::winapi::DWORD_ dwDesiredAccess);
67 BOOST_WINAPI_IMPORT_EXCEPT_WM boost::winapi::HANDLE_ BOOST_WINAPI_WINAPI_CC
69 boost::winapi::DWORD_ dwDesiredAccess,
70 boost::winapi::BOOL_ bInheritHandle,
71 boost::winapi::LPCWSTR_ lpName);
73 // Windows CE define SetEvent/ResetEvent as inline functions in kfuncs.h
74 #if !defined( UNDER_CE )
75 BOOST_WINAPI_IMPORT boost::winapi::BOOL_ BOOST_WINAPI_WINAPI_CC
76 SetEvent(boost::winapi::HANDLE_ hEvent);
78 BOOST_WINAPI_IMPORT boost::winapi::BOOL_ BOOST_WINAPI_WINAPI_CC
79 ResetEvent(boost::winapi::HANDLE_ hEvent);
87 #if !defined( BOOST_NO_ANSI_APIS )
94 #if defined( BOOST_USE_WINDOWS_H )
96 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_ALL_ACCESS_ = EVENT_ALL_ACCESS;
97 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_MODIFY_STATE_ = EVENT_MODIFY_STATE;
98 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
99 BOOST_CONSTEXPR_OR_CONST DWORD_ CREATE_EVENT_INITIAL_SET_ = CREATE_EVENT_INITIAL_SET;
100 BOOST_CONSTEXPR_OR_CONST DWORD_ CREATE_EVENT_MANUAL_RESET_ = CREATE_EVENT_MANUAL_RESET;
103 #else // defined( BOOST_USE_WINDOWS_H )
105 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_ALL_ACCESS_ = 0x001F0003;
106 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_MODIFY_STATE_ = 0x00000002;
107 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
108 BOOST_CONSTEXPR_OR_CONST DWORD_ CREATE_EVENT_INITIAL_SET_ = 0x00000002;
109 BOOST_CONSTEXPR_OR_CONST DWORD_ CREATE_EVENT_MANUAL_RESET_ = 0x00000001;
112 #endif // defined( BOOST_USE_WINDOWS_H )
114 // Undocumented and not present in Windows SDK. Enables NtQueryEvent.
115 // http://undocumented.ntinternals.net/index.html?page=UserMode%2FUndocumented%20Functions%2FNT%20Objects%2FEvent%2FNtQueryEvent.html
116 BOOST_CONSTEXPR_OR_CONST DWORD_ EVENT_QUERY_STATE_ = 0x00000001;
118 BOOST_CONSTEXPR_OR_CONST DWORD_ event_all_access = EVENT_ALL_ACCESS_;
119 BOOST_CONSTEXPR_OR_CONST DWORD_ event_modify_state = EVENT_MODIFY_STATE_;
120 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
121 BOOST_CONSTEXPR_OR_CONST DWORD_ create_event_initial_set = CREATE_EVENT_INITIAL_SET_;
122 BOOST_CONSTEXPR_OR_CONST DWORD_ create_event_manual_reset = CREATE_EVENT_MANUAL_RESET_;
125 #if !defined( BOOST_NO_ANSI_APIS )
126 BOOST_FORCEINLINE HANDLE_ CreateEventA(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState, LPCSTR_ lpName)
128 #if !BOOST_WINAPI_PARTITION_APP_SYSTEM && BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
129 const DWORD_ flags = (bManualReset ? create_event_manual_reset : 0u) | (bInitialState ? create_event_initial_set : 0u);
130 return ::CreateEventExA(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), lpName, flags, event_all_access);
132 return ::CreateEventA(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), bManualReset, bInitialState, lpName);
136 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
137 BOOST_FORCEINLINE HANDLE_ CreateEventExA(SECURITY_ATTRIBUTES_* lpEventAttributes, LPCSTR_ lpName, DWORD_ dwFlags, DWORD_ dwDesiredAccess)
139 return ::CreateEventExA(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), lpName, dwFlags, dwDesiredAccess);
144 BOOST_FORCEINLINE HANDLE_ CreateEventW(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState, LPCWSTR_ lpName)
146 #if !BOOST_WINAPI_PARTITION_APP_SYSTEM && BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
147 const DWORD_ flags = (bManualReset ? create_event_manual_reset : 0u) | (bInitialState ? create_event_initial_set : 0u);
148 return ::CreateEventExW(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), lpName, flags, event_all_access);
150 return ::CreateEventW(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), bManualReset, bInitialState, lpName);
154 #if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
155 BOOST_FORCEINLINE HANDLE_ CreateEventExW(SECURITY_ATTRIBUTES_* lpEventAttributes, LPCWSTR_ lpName, DWORD_ dwFlags, DWORD_ dwDesiredAccess)
157 return ::CreateEventExW(reinterpret_cast< ::_SECURITY_ATTRIBUTES* >(lpEventAttributes), lpName, dwFlags, dwDesiredAccess);
161 #if !defined( BOOST_NO_ANSI_APIS )
162 BOOST_FORCEINLINE HANDLE_ create_event(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState, LPCSTR_ lpName)
164 return winapi::CreateEventA(lpEventAttributes, bManualReset, bInitialState, lpName);
167 BOOST_FORCEINLINE HANDLE_ open_event(DWORD_ dwDesiredAccess, BOOL_ bInheritHandle, LPCSTR_ lpName)
169 return ::OpenEventA(dwDesiredAccess, bInheritHandle, lpName);
173 BOOST_FORCEINLINE HANDLE_ create_event(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState, LPCWSTR_ lpName)
175 return winapi::CreateEventW(lpEventAttributes, bManualReset, bInitialState, lpName);
178 BOOST_FORCEINLINE HANDLE_ open_event(DWORD_ dwDesiredAccess, BOOL_ bInheritHandle, LPCWSTR_ lpName)
180 return ::OpenEventW(dwDesiredAccess, bInheritHandle, lpName);
183 BOOST_FORCEINLINE HANDLE_ create_anonymous_event(SECURITY_ATTRIBUTES_* lpEventAttributes, BOOL_ bManualReset, BOOL_ bInitialState)
185 return winapi::CreateEventW(lpEventAttributes, bManualReset, bInitialState, 0);
191 #include <boost/winapi/detail/footer.hpp>
193 #endif // BOOST_WINAPI_EVENT_HPP_INCLUDED_