_com_error Class Reference

#include <comdef.h>

Public Member Functions
	_com_error (HRESULT hr, IErrorInfo *perrinfo=NULL, bool fAddRef=false) throw ()
	_com_error (const _com_error &that) throw ()
virtual	~_com_error () throw ()
_com_error &	operator= (const _com_error &that) throw ()
HRESULT	Error () const throw ()
WORD	WCode () const throw ()
IErrorInfo *	ErrorInfo () const throw ()
_bstr_t	Description () const
DWORD	HelpContext () const throw ()
_bstr_t	HelpFile () const
_bstr_t	Source () const
GUID	GUID () const throw ()
const TCHAR *	ErrorMessage () const throw ()

Static Public Member Functions
static HRESULT	WCodeToHRESULT (WORD wCode) throw ()
static WORD	HRESULTToWCode (HRESULT hr) throw ()

Private Types
enum	{ WCODE_HRESULT_FIRST = MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 0x200), WCODE_HRESULT_LAST = MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF+1, 0) - 1 }

Private Attributes
const HRESULT	m_hresult
IErrorInfo *	m_perrinfo
TCHAR *	m_pszMsg

Member Enumeration Documentation

anonymous enum

private

Enumerator
WCODE_HRESULT_FIRST
WCODE_HRESULT_LAST

         {
        WCODE_HRESULT_FIRST = MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, 0x200),
        WCODE_HRESULT_LAST = MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF+1, 0) - 1
    };

Constructor & Destructor Documentation

_com_error::_com_error ( HRESULT  hr, IErrorInfo *  perrinfo = NULL, bool  fAddRef = false  ) throw ( )

inline

    : m_hresult(hr), m_perrinfo(perrinfo), m_pszMsg(NULL)
{
    if (m_perrinfo != NULL && fAddRef) {
        m_perrinfo->AddRef();
    }
}

_com_error::_com_error ( const _com_error &  that ) throw ( )

inline

    : m_hresult(that.m_hresult), m_perrinfo(that.m_perrinfo), m_pszMsg(NULL)
{
    if (m_perrinfo != NULL) {
        m_perrinfo->AddRef();
    }
}

_com_error::~_com_error ( ) throw ( )

inlinevirtual

{
    if (m_perrinfo != NULL) {
        m_perrinfo->Release();
    }
    if (m_pszMsg != NULL) {
        LocalFree((HLOCAL)m_pszMsg);
    }
}

Member Function Documentation

_bstr_t _com_error::Description ( ) const

inline

{
    BSTR bstr = NULL;
    if (m_perrinfo != NULL) {
        if (FAILED(m_perrinfo->GetDescription(&bstr))) {
            bstr = NULL;
        }
    }
    return _bstr_t(bstr, false);
}

HRESULT _com_error::Error ( ) const throw ( )

inline

{
    return m_hresult;
}

IErrorInfo * _com_error::ErrorInfo ( ) const throw ( )

inline

{
    if (m_perrinfo != NULL) {
        m_perrinfo->AddRef();
    }
    return m_perrinfo;
}

const TCHAR * _com_error::ErrorMessage ( ) const throw ( )

inline

{
    if (m_pszMsg == NULL) {
        FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
                          FORMAT_MESSAGE_FROM_SYSTEM|
                          FORMAT_MESSAGE_IGNORE_INSERTS,
                      NULL,
                      m_hresult,
                      MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
                      (LPTSTR)&m_pszMsg,
                      0,
                      NULL);
        if (m_pszMsg != NULL) {
            #ifdef UNICODE
            size_t const nLen = wcslen(m_pszMsg);
            #else
            size_t const nLen = strlen(m_pszMsg);
            #endif
            if (nLen > 1 && m_pszMsg[nLen - 1] == '\n') {
                m_pszMsg[nLen - 1] = 0;
                if (m_pszMsg[nLen - 2] == '\r') {
                        m_pszMsg[nLen - 2] = 0;
                }
            }
        }
        else {
            m_pszMsg = (LPTSTR)LocalAlloc(0, 32 * sizeof(TCHAR));
            if (m_pszMsg != NULL) {
                WORD wCode = WCode();
                if (wCode != 0) {
                    _COM_PRINTF_S_1(m_pszMsg, 32, TEXT("IDispatch error #%d"), (int)wCode);
                }
                else {
                    _COM_PRINTF_S_1(m_pszMsg, 32, TEXT("Unknown error 0x%0lX"), m_hresult);
                }
            }
        }
    }
    return m_pszMsg;
}

_GUID _com_error::GUID ( ) const throw ( )

inline

{
    _GUID guid{};
    if (m_perrinfo != NULL) {
        if (FAILED(m_perrinfo->GetGUID(&guid))) {
            guid = _GUID{};
        }
    }
    return guid;
}

DWORD _com_error::HelpContext ( ) const throw ( )

inline

{
    DWORD dwHelpContext = 0;
    if (m_perrinfo != NULL) {
        if (FAILED(m_perrinfo->GetHelpContext(&dwHelpContext))) {
            dwHelpContext = 0;
        }
    }
    return dwHelpContext;
}

_bstr_t _com_error::HelpFile ( ) const

inline

{
    BSTR bstr = NULL;
    if (m_perrinfo != NULL) {
        if (FAILED(m_perrinfo->GetHelpFile(&bstr))) {
            bstr = NULL;
        }
    }
    return _bstr_t(bstr, false);
}

WORD _com_error::HRESULTToWCode ( HRESULT  hr ) throw ( )

inlinestatic

{
    return (hr >= WCODE_HRESULT_FIRST && hr <= WCODE_HRESULT_LAST)
        ? WORD(hr - WCODE_HRESULT_FIRST)
        : 0;
}

_com_error & _com_error::operator= ( const _com_error &  that ) throw ( )

inline

{
    if (this != &that) {
        this->_com_error::~_com_error();
        this->_com_error::_com_error(that);
    }
    return *this;
}

_bstr_t _com_error::Source ( ) const

inline

{
    BSTR bstr = NULL;
    if (m_perrinfo != NULL) {
        if (FAILED(m_perrinfo->GetSource(&bstr))) {
            bstr = NULL;
        }
    }
    return _bstr_t(bstr, false);
}

WORD _com_error::WCode ( ) const throw ( )

inline

{
    return HRESULTToWCode(m_hresult);
}

HRESULT _com_error::WCodeToHRESULT ( WORD  wCode ) throw ( )

inlinestatic

{
    return wCode >= 0xFE00 ? WCODE_HRESULT_LAST : WCODE_HRESULT_FIRST + wCode;
}

Member Data Documentation

const HRESULT _com_error::m_hresult

private

IErrorInfo* _com_error::m_perrinfo

private

TCHAR* _com_error::m_pszMsg

mutableprivate

---

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

• VS2017/inc/comdef.h