CAtlException Class
This class defines an ATL exception.
Syntax
class CAtlException
Members
Public Constructors
Name | Description |
---|---|
CAtlException::CAtlException | The constructor. |
Public Operators
Name | Description |
---|---|
CAtlException::operator HRESULT | Casts the current object to an HRESULT value. |
Public Data Members
Name | Description |
---|---|
CAtlException::m_hr | The variable of type HRESULT created by the object and used to store the error condition. |
Remarks
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.
Requirements
Header: atlexcept.h
CAtlException::CAtlException
The constructor.
CAtlException(HRESULT hr) throw();
CAtlException() throw();
Parameters
hr
The HRESULT error code.
CAtlException::operator HRESULT
Casts the current object to an HRESULT value.
operator HRESULT() const throw ();
CAtlException::m_hr
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.