OW32::CEvent Class Reference

Wrapper for a Win32 Event object. More...

#include <SyncObjects.h>

Inheritance diagram for OW32::CEvent:

List of all members.

Public Member Functions
	CEvent (BOOL bManualReset=FALSE, BOOL bInitialState=FALSE, LPCTSTR lpszName=NULL, LPSECURITY_ATTRIBUTES lpSecAttr=NULL)
	Construct a new event object.
	CEvent (HANDLE hEvent)
	Construct a new event object.
CEvent &	operator= (HANDLE hEvent)
	Set the encapsulated event handle.
virtual BOOL	Lock (DWORD dwTimeout=INFINITE)
	Wait for the event.
void	Unlock ()
	Unused, event objects do not `unlock'.
BOOL	Set ()
	Signal the event object.
BOOL	Reset ()
	Clear the signalled state of the event object.
BOOL	Pulse ()
	Briefly set the event object to the signalled state.
	operator HANDLE () const
	HANDLE extract for the event object.

---

Detailed Description

Wrapper for a Win32 Event object.

---

Constructor & Destructor Documentation

OW32::CEvent::CEvent (  BOOL  bManualReset = FALSE, BOOL  bInitialState = FALSE, LPCTSTR  lpszName = NULL, LPSECURITY_ATTRIBUTES  lpSecAttr = NULL )  [inline]

Construct a new event object. Parameters: bManualReset  flag set if the event requires resetting manually bInitialState  the initial state (signalled/non-signalled) of the event lpszName  the name of the event object lpSecAttr  security attributes for the event object

OW32::CEvent::CEvent (  HANDLE  hEvent  )  [inline]

Construct a new event object. Parameters: hEvent  Existing event to encapsulate

---

Member Function Documentation

virtual BOOL OW32::CEvent::Lock (  DWORD  dwTimeout = INFINITE  )  [inline, virtual]

Wait for the event. Returns: TRUE if successful, FALSE otherwise Parameters: dwTimeout  The length of time to wait for the event Implements OW32::CSyncObject.

CEvent& OW32::CEvent::operator= (  HANDLE  hEvent  )  [inline]

Set the encapsulated event handle. Parameters: hEvent  the new event

---

The documentation for this class was generated from the following file:

• SyncObjects.h

---