CAtlException Class

 

For the latest documentation on Visual Studio 2017, see Visual Studio 2017 Documentation.

This class defines an ATL exception.

class CAtlException

Public Constructors

NameDescription
CAtlException::CAtlExceptionThe constructor.

Public Operators

NameDescription
CAtlException::operator HRESULTCasts the current object to an HRESULT value.

Public Data Members

NameDescription
CAtlException::m_hrThe variable of type HRESULT created by the object and used to store the error condition.

A CAtlException object represents an exception condition related to an ATL operation. The CAtlException class includes a public data member that stores the status code indicating the reason for the exception and a cast operator that allows you to treat the exception as if it were an HRESULT.

In general, you will call AtlThrow rather than creating a CAtlException object directly.

Header: atlexcept.h

The constructor.

CAtlException(HRESULT hr) throw();
CAtlException() throw();

Parameters

hr
The HRESULT error code.

Casts the current object to an HRESULT value.

operator HRESULT() const throw ();

The HRESULT data member.

HRESULT m_hr;

Remarks

The data member that stores the error condition. The HRESULT value is set by the constructor, CAtlException::CAtlException.

AtlThrow
Class Overview

Show: