Skip to content

AWin32Event#

Encapsulates calls to CreateEvent/

Header:#include <AUI/Platform/win32/AWin32Event.h>
CMake:aui_link(my_target PUBLIC aui::core)

Public Methods#

AWin32Event#


AWin32Event::AWin32Event(LPSECURITY_ATTRIBUTES securityAttributes, bool manualReset, bool initialState, LPCWSTR name)

Creates or opens a named or unnamed event object.

Arguments
securityAttributes
A pointer to a SECURITY_ATTRIBUTES structure. If this parameter is NULL, the handle cannot be inherited by child processes. The lpSecurityDescriptor member of the structure specifies a security descriptor for the new event. If lpEventAttributes is NULL, the event gets a default security descriptor. The ACLs in the default security descriptor for an event come from the primary or impersonation token of the creator.
manualReset
If this parameter is TRUE, the function creates a manual-reset event object, which requires the use of the ResetEvent function to set the event state to nonsignaled. If this parameter is FALSE, the function creates an auto-reset event object, and system automatically resets the event state to nonsignaled after a single waiting thread has been release.
initialState
If this parameter is TRUE, the initial state of the event object is signaled; otherwise, it is nonsignaled.
name
The name of the event object. The name is limited to MAX_PATH characters. Name comparison is case sensitive.