ATL::CAtlFileMappingBase Class Reference

#include <atlfile.h>

Inheritance diagram for ATL::CAtlFileMappingBase:

Collaboration diagram for ATL::CAtlFileMappingBase:

Public Member Functions
	CAtlFileMappingBase () noexcept
	~CAtlFileMappingBase () noexcept
	CAtlFileMappingBase (CAtlFileMappingBase &orig)
CAtlFileMappingBase &	operator= (CAtlFileMappingBase &orig)
HRESULT	CopyFrom (CAtlFileMappingBase &orig) noexcept
HRESULT	MapFile (HANDLE hFile, SIZE_T nMappingSize=0, ULONGLONG nOffset=0, DWORD dwMappingProtection=PAGE_READONLY, DWORD dwViewDesiredAccess=FILE_MAP_READ) noexcept
HRESULT	MapSharedMem (SIZE_T nMappingSize, LPCTSTR szName, BOOL *pbAlreadyExisted=NULL, LPSECURITY_ATTRIBUTES lpsa=NULL, DWORD dwMappingProtection=PAGE_READWRITE, DWORD dwViewDesiredAccess=FILE_MAP_ALL_ACCESS) noexcept
HRESULT	OpenMapping (LPCTSTR szName, SIZE_T nMappingSize, ULONGLONG nOffset=0, DWORD dwViewDesiredAccess=FILE_MAP_ALL_ACCESS) noexcept
HRESULT	Unmap () noexcept
void *	GetData () const noexcept
HANDLE	GetHandle () throw ()
SIZE_T	GetMappingSize () noexcept

Private Attributes
void *	m_pData
SIZE_T	m_nMappingSize
HANDLE	m_hMapping
ULARGE_INTEGER	m_nOffset
DWORD	m_dwViewDesiredAccess

Detailed Description

Definition at line 27 of file atlfile.h.

Constructor & Destructor Documentation

CAtlFileMappingBase() [1/2]

ATL::CAtlFileMappingBase::CAtlFileMappingBase ( )

inlinenoexcept

Definition at line 37 of file atlfile.h.

        :m_pData(NULL)
        ,m_nMappingSize(0)
        ,m_hMapping(NULL)
        ,m_dwViewDesiredAccess(0)
    {
        m_nOffset.QuadPart = 0;
    }

~CAtlFileMappingBase()

ATL::CAtlFileMappingBase::~CAtlFileMappingBase ( )

inlinenoexcept

Definition at line 46 of file atlfile.h.

    {
        Unmap();
    }

CAtlFileMappingBase() [2/2]

ATL::CAtlFileMappingBase::CAtlFileMappingBase ( CAtlFileMappingBase &  orig )

inline

Definition at line 51 of file atlfile.h.

    {
        HRESULT hr;
 
        m_pData = NULL;
        m_nMappingSize = 0;
        m_hMapping = NULL;
        m_dwViewDesiredAccess = 0;
        m_nOffset.QuadPart = 0;
 
        hr = CopyFrom(orig);
        if (FAILED(hr))
            AtlThrow(hr);
    }

Member Function Documentation

CopyFrom()

HRESULT ATL::CAtlFileMappingBase::CopyFrom ( CAtlFileMappingBase &  orig )

inlinenoexcept

Definition at line 77 of file atlfile.h.

    {
        HRESULT hr = S_OK;
 
        if (&orig == this)
            return S_OK;
 
        ATLASSERT(m_pData == NULL);
        ATLASSERT(m_hMapping == NULL);
        ATLASSERT(orig.m_pData != NULL);
 
        m_nMappingSize = orig.m_nMappingSize;
        m_nOffset.QuadPart = orig.m_nOffset.QuadPart;
        m_dwViewDesiredAccess = orig.m_dwViewDesiredAccess;
 
        if (::DuplicateHandle(GetCurrentProcess(), orig.m_hMapping, GetCurrentProcess(), &m_hMapping, 0, TRUE, DUPLICATE_SAME_ACCESS))
        {
            m_pData = ::MapViewOfFile(m_hMapping, m_dwViewDesiredAccess, m_nOffset.HighPart, m_nOffset.LowPart, m_nMappingSize);
            if (!m_pData)
            {
                hr = AtlHresultFromLastError();
                ::CloseHandle(m_hMapping);
                m_hMapping = NULL;
            }
        }
        else
        {
            hr = AtlHresultFromLastError();
        }
 
        return hr;
    }

Referenced by CAtlFileMappingBase(), and operator=().

GetData()

void * ATL::CAtlFileMappingBase::GetData ( ) const

inlinenoexcept

Definition at line 251 of file atlfile.h.

    {
        return m_pData;
    }

Referenced by ATL::CAtlFileMapping< T >::operator T*().

GetHandle()

HANDLE ATL::CAtlFileMappingBase::GetHandle ( ) throw ( )

inline

Definition at line 256 of file atlfile.h.

    {
        return m_hMapping;
    }

GetMappingSize()

SIZE_T ATL::CAtlFileMappingBase::GetMappingSize ( )

inlinenoexcept

Definition at line 261 of file atlfile.h.

    {
        return m_nMappingSize;
    }

MapFile()

HRESULT ATL::CAtlFileMappingBase::MapFile ( HANDLE  hFile, SIZE_T  nMappingSize = 0, ULONGLONG  nOffset = 0, DWORD  dwMappingProtection = PAGE_READONLY, DWORD  dwViewDesiredAccess = FILE_MAP_READ  )

inlinenoexcept

Definition at line 110 of file atlfile.h.

    {
        HRESULT hr = S_OK;
        ULARGE_INTEGER FileSize;
 
        ATLASSERT(hFile != INVALID_HANDLE_VALUE);
        ATLASSERT(m_pData == NULL);
        ATLASSERT(m_hMapping == NULL);
 
        FileSize.LowPart = ::GetFileSize(hFile, &FileSize.HighPart);
        FileSize.QuadPart = nMappingSize > FileSize.QuadPart ? nMappingSize : FileSize.QuadPart;
 
        m_hMapping = ::CreateFileMapping(hFile, NULL, dwMappingProtection, FileSize.HighPart, FileSize.LowPart, 0);
        if (m_hMapping)
        {
            m_nMappingSize = nMappingSize == 0 ? (SIZE_T)(FileSize.QuadPart - nOffset) : nMappingSize;
            m_nOffset.QuadPart = nOffset;
            m_dwViewDesiredAccess = dwViewDesiredAccess;
 
            m_pData = ::MapViewOfFile(m_hMapping, m_dwViewDesiredAccess, m_nOffset.HighPart, m_nOffset.LowPart, m_nMappingSize);
            if (!m_pData)
            {
                hr = AtlHresultFromLastError();
                ::CloseHandle(m_hMapping);
                m_hMapping = NULL;
            }
        }
        else
        {
            hr = AtlHresultFromLastError();
        }
 
        return hr;
    }

MapSharedMem()

HRESULT ATL::CAtlFileMappingBase::MapSharedMem ( SIZE_T  nMappingSize, LPCTSTR  szName, BOOL *  pbAlreadyExisted = NULL, LPSECURITY_ATTRIBUTES  lpsa = NULL, DWORD  dwMappingProtection = PAGE_READWRITE, DWORD  dwViewDesiredAccess = FILE_MAP_ALL_ACCESS  )

inlinenoexcept

Definition at line 150 of file atlfile.h.

    {
        HRESULT hr = S_OK;
        ULARGE_INTEGER Size;
 
        ATLASSERT(nMappingSize > 0);
        ATLASSERT(szName != NULL);
        ATLASSERT(m_pData == NULL);
        ATLASSERT(m_hMapping == NULL);
 
        m_nMappingSize = nMappingSize;
        m_dwViewDesiredAccess = dwViewDesiredAccess;
        m_nOffset.QuadPart = 0;
        Size.QuadPart = nMappingSize;
 
        m_hMapping = ::CreateFileMapping(NULL, lpsa, dwMappingProtection, Size.HighPart, Size.LowPart, szName);
        if (m_hMapping != NULL)
        {
            if (pbAlreadyExisted)
                *pbAlreadyExisted = GetLastError() == ERROR_ALREADY_EXISTS;
 
            m_pData = ::MapViewOfFile(m_hMapping, dwViewDesiredAccess, m_nOffset.HighPart, m_nOffset.LowPart, m_nMappingSize);
            if (!m_pData)
            {
                hr = AtlHresultFromLastError();
                ::CloseHandle(m_hMapping);
                m_hMapping = NULL;
            }
        }
        else
        {
            hr = AtlHresultFromLastError();
        }
 
        return hr;
    }

OpenMapping()

HRESULT ATL::CAtlFileMappingBase::OpenMapping ( LPCTSTR  szName, SIZE_T  nMappingSize, ULONGLONG  nOffset = 0, DWORD  dwViewDesiredAccess = FILE_MAP_ALL_ACCESS  )

inlinenoexcept

Definition at line 193 of file atlfile.h.

    {
        HRESULT hr = S_OK;
 
        ATLASSERT(szName != NULL);
        ATLASSERT(m_pData == NULL);
        ATLASSERT(m_hMapping == NULL);
 
        m_nMappingSize = nMappingSize;
        m_dwViewDesiredAccess = dwViewDesiredAccess;
        m_nOffset.QuadPart = nOffset;
 
        m_hMapping = ::OpenFileMapping(m_dwViewDesiredAccess, FALSE, szName);
        if (m_hMapping)
        {
            m_pData = ::MapViewOfFile(m_hMapping, dwViewDesiredAccess, m_nOffset.HighPart, m_nOffset.LowPart, m_nMappingSize);
            if (!m_pData)
            {
                hr = AtlHresultFromLastError();
                ::CloseHandle(m_hMapping);
                m_hMapping = NULL;
            }
        }
        else
        {
            hr = AtlHresultFromLastError();
        }
 
        return hr;
    }

operator=()

CAtlFileMappingBase & ATL::CAtlFileMappingBase::operator= ( CAtlFileMappingBase &  orig )

inline

Definition at line 66 of file atlfile.h.

    {
        HRESULT hr;
 
        hr = CopyFrom(orig);
        if (FAILED(hr))
            AtlThrow(hr);
 
        return *this;
    }

Unmap()

HRESULT ATL::CAtlFileMappingBase::Unmap ( )

inlinenoexcept

Definition at line 228 of file atlfile.h.

    {
        HRESULT hr = S_OK;
 
        if (m_pData)
        {
            if (!::UnmapViewOfFile(m_pData))
                hr = AtlHresultFromLastError();
 
            m_pData = NULL;
        }
        if (m_hMapping)
        {
            // If we already had an error, do not overwrite it
            if (!::CloseHandle(m_hMapping) && SUCCEEDED(hr))
                hr = AtlHresultFromLastError();
 
            m_hMapping = NULL;
        }
 
        return hr;
    }

Referenced by ~CAtlFileMappingBase().

Member Data Documentation

m_dwViewDesiredAccess

DWORD ATL::CAtlFileMappingBase::m_dwViewDesiredAccess

private

Definition at line 34 of file atlfile.h.

Referenced by CAtlFileMappingBase(), CopyFrom(), MapFile(), MapSharedMem(), and OpenMapping().

m_hMapping

HANDLE ATL::CAtlFileMappingBase::m_hMapping

private

Definition at line 32 of file atlfile.h.

Referenced by CAtlFileMappingBase(), CopyFrom(), GetHandle(), MapFile(), MapSharedMem(), OpenMapping(), and Unmap().

m_nMappingSize

SIZE_T ATL::CAtlFileMappingBase::m_nMappingSize

private

Definition at line 31 of file atlfile.h.

Referenced by CAtlFileMappingBase(), CopyFrom(), GetMappingSize(), MapFile(), MapSharedMem(), and OpenMapping().

m_nOffset

ULARGE_INTEGER ATL::CAtlFileMappingBase::m_nOffset

private

Definition at line 33 of file atlfile.h.

Referenced by CAtlFileMappingBase(), CopyFrom(), MapFile(), MapSharedMem(), and OpenMapping().

m_pData

void* ATL::CAtlFileMappingBase::m_pData

private

Definition at line 30 of file atlfile.h.

Referenced by CAtlFileMappingBase(), CopyFrom(), GetData(), MapFile(), MapSharedMem(), OpenMapping(), and Unmap().

---

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

• sdk/lib/atl/atlfile.h