ATL::CHandle Class Reference

#include <atlbase.h>

Inheritance diagram for ATL::CHandle:

Collaboration diagram for ATL::CHandle:

Public Member Functions
	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
HANDLE	m_handle

Detailed Description

Definition at line 301 of file atlbase.h.

Constructor & Destructor Documentation

CHandle() [1/3]

ATL::CHandle::CHandle ( )

inline

Definition at line 307 of file atlbase.h.

              :
        m_handle(NULL)
    {
    }

CHandle() [2/3]

ATL::CHandle::CHandle ( _Inout_ CHandle &  handle )

inline

Definition at line 312 of file atlbase.h.

                                     :
        m_handle(NULL)
    {
        Attach(handle.Detach());
    }

CHandle() [3/3]

ATL::CHandle::CHandle ( _In_ HANDLE  handle )

inlineexplicit

Definition at line 318 of file atlbase.h.

                                         :
        m_handle(handle)
    {
    }

~CHandle()

ATL::CHandle::~CHandle ( )

inline

Definition at line 323 of file atlbase.h.

    {
        if (m_handle)
        {
            Close();
        }
    }

Member Function Documentation

Attach()

void ATL::CHandle::Attach ( _In_ HANDLE  handle )

inline

Definition at line 350 of file atlbase.h.

    {
        ATLASSERT(m_handle == NULL);
        m_handle = handle;
    }

Referenced by CHandle(), ATL::CMutex::Create(), ATL::CEvent::Create(), ATL::CSemaphore::Create(), ATL::CEvent::Open(), ATL::CMutex::Open(), ATL::CSemaphore::Open(), and operator=().

Close()

void ATL::CHandle::Close ( )

inline

Definition at line 363 of file atlbase.h.

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

Referenced by operator=(), and ~CHandle().

Detach()

HANDLE ATL::CHandle::Detach ( )

inline

Definition at line 356 of file atlbase.h.

    {
        HANDLE handle = m_handle;
        m_handle = NULL;
        return handle;
    }

operator HANDLE()

ATL::CHandle::operator HANDLE ( ) const

inline

Definition at line 345 of file atlbase.h.

    {
        return m_handle;
    }

operator=()

CHandle & ATL::CHandle::operator= ( _Inout_ CHandle &  handle )

inline

Definition at line 331 of file atlbase.h.

    {
        if (this != &handle)
        {
            if (m_handle)
            {
                Close();
            }
            Attach(handle.Detach());
        }
 
        return *this;
    }

Member Data Documentation

m_handle

HANDLE ATL::CHandle::m_handle

Definition at line 304 of file atlbase.h.

Referenced by Attach(), Close(), Detach(), operator HANDLE(), operator=(), and ~CHandle().

---

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

• sdk/lib/atl/atlbase.h