ATL::CEvent Class Reference

#include <atlsync.h>

Inheritance diagram for ATL::CEvent:

Collaboration diagram for ATL::CEvent:

Private Member Functions
	CEvent ()
	CEvent (CEvent &hEvent)
	CEvent (BOOL bManualReset, BOOL bInitialState)
	CEvent (LPSECURITY_ATTRIBUTES pSecurity, BOOL bManualReset, BOOL bInitialState, LPCTSTR pszName)
	CEvent (HANDLE hEvent)
BOOL	Create (LPSECURITY_ATTRIBUTES pSecurity, BOOL bManualReset, BOOL bInitialState, LPCTSTR pszName)
BOOL	Open (DWORD dwAccess, BOOL bInheritHandle, LPCTSTR pszName)
BOOL	Set ()
BOOL	Reset ()
BOOL	Pulse ()

Additional Inherited Members
Public Member Functions inherited from ATL::CHandle
	CHandle ()
	CHandle (_Inout_ CHandle &handle)
	CHandle (_In_ HANDLE handle)
	~CHandle ()
CHandle &	operator= (_Inout_ CHandle &handle)
	operator HANDLE () const
void	Attach (_In_ HANDLE handle)
HANDLE	Detach ()
void	Close ()
Public Attributes inherited from ATL::CHandle
HANDLE	m_handle

Detailed Description

Definition at line 46 of file atlsync.h.

Constructor & Destructor Documentation

CEvent() [1/5]

ATL::CEvent::CEvent ( )

inlineprivate

Definition at line 48 of file atlsync.h.

    {
    }

CEvent() [2/5]

ATL::CEvent::CEvent ( CEvent &  hEvent )

inlineprivate

Definition at line 52 of file atlsync.h.

                           : CHandle(hEvent)
    {
    }

CEvent() [3/5]

ATL::CEvent::CEvent ( BOOL  bManualReset, BOOL  bInitialState  )

inlineprivate

Definition at line 56 of file atlsync.h.

    {
        Create(NULL, bManualReset, bInitialState, NULL);
    }

CEvent() [4/5]

ATL::CEvent::CEvent ( LPSECURITY_ATTRIBUTES  pSecurity, BOOL  bManualReset, BOOL  bInitialState, LPCTSTR  pszName  )

inlineprivate

Definition at line 61 of file atlsync.h.

    {
        Create(pSecurity, bManualReset, bInitialState, pszName);
    }

CEvent() [5/5]

ATL::CEvent::CEvent ( HANDLE  hEvent )

inlineexplicitprivate

Definition at line 66 of file atlsync.h.

                                   : CHandle(hEvent)
    {
    }

Member Function Documentation

Create()

BOOL ATL::CEvent::Create ( LPSECURITY_ATTRIBUTES  pSecurity, BOOL  bManualReset, BOOL  bInitialState, LPCTSTR  pszName  )

inlineprivate

Definition at line 70 of file atlsync.h.

    {
        HANDLE hEvent = ::CreateEvent(pSecurity, bManualReset, bInitialState, pszName);
        ATLASSERT(hEvent != NULL);
        Attach(hEvent);
        return hEvent != NULL;
    }

Open()

BOOL ATL::CEvent::Open ( DWORD  dwAccess, BOOL  bInheritHandle, LPCTSTR  pszName  )

inlineprivate

Definition at line 78 of file atlsync.h.

    {
        HANDLE hEvent = ::OpenEvent(dwAccess, bInheritHandle, pszName);
        ATLASSERT(hEvent != NULL);
        Attach(hEvent);
        return hEvent != NULL;
    }

Pulse()

BOOL ATL::CEvent::Pulse ( )

inlineprivate

Definition at line 98 of file atlsync.h.

    {
        ATLASSERT(*this);
        return ::PulseEvent(*this);
    }

Reset()

BOOL ATL::CEvent::Reset ( )

inlineprivate

Definition at line 92 of file atlsync.h.

    {
        ATLASSERT(*this);
        return ::ResetEvent(*this);
    }

Set()

BOOL ATL::CEvent::Set ( )

inlineprivate

Definition at line 86 of file atlsync.h.

    {
        ATLASSERT(*this);
        return ::SetEvent(*this);
    }

---

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

• sdk/lib/atl/atlsync.h