CicEvent Class Reference

#include <cicevent.h>

Collaboration diagram for CicEvent:

Public Member Functions
	CicEvent ()
	~CicEvent ()
BOOL	Create (LPSECURITY_ATTRIBUTES lpSA, LPCTSTR pszName)
BOOL	Open (LPCTSTR pszName)
void	Close ()
BOOL	Wait (DWORD dwMilliseconds)

Private Attributes
HANDLE	m_hEvent
LPCTSTR	m_pszName

Detailed Description

Definition at line 12 of file cicevent.h.

Constructor & Destructor Documentation

CicEvent()

CicEvent::CicEvent ( )

inline

Definition at line 18 of file cicevent.h.

               : m_hEvent(NULL), m_pszName(NULL)
    {
    }

~CicEvent()

CicEvent::~CicEvent ( )

inline

Definition at line 21 of file cicevent.h.

    {
        Close();
    }

Member Function Documentation

Close()

void CicEvent::Close ( )

inline

Definition at line 42 of file cicevent.h.

    {
        if (m_hEvent)
        {
            ::CloseHandle(m_hEvent);
            m_hEvent = NULL;
        }
    }

Referenced by ~CicEvent().

Create()

BOOL CicEvent::Create ( LPSECURITY_ATTRIBUTES  lpSA, LPCTSTR  pszName  )

inline

Definition at line 26 of file cicevent.h.

    {
        if (pszName)
            m_pszName = pszName;
        if (!m_pszName)
            return FALSE;
        m_hEvent = ::CreateEvent(lpSA, FALSE, FALSE, m_pszName);
        return (m_hEvent != NULL);
    }

Open()

BOOL CicEvent::Open ( LPCTSTR  pszName )

inline

Definition at line 35 of file cicevent.h.

    {
        if (pszName)
            m_pszName = pszName;
        m_hEvent = ::OpenEvent(EVENT_ALL_ACCESS, FALSE, m_pszName);
        return (m_hEvent != NULL);
    }

Wait()

BOOL CicEvent::Wait ( DWORD  dwMilliseconds )

inline

Definition at line 51 of file cicevent.h.

    {
        return (::WaitForSingleObject(m_hEvent, dwMilliseconds) == WAIT_OBJECT_0);
    }

Member Data Documentation

m_hEvent

HANDLE CicEvent::m_hEvent

private

Definition at line 14 of file cicevent.h.

Referenced by Close(), Create(), Open(), and Wait().

m_pszName

LPCTSTR CicEvent::m_pszName

private

Definition at line 15 of file cicevent.h.

Referenced by Create(), and Open().

---

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

• sdk/lib/cicero/cicevent.h