Humble Framework for SkyOS
Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

HError Class Reference
[Base]

#include <HError.h>

Inheritance diagram for HError:

HObj

Detailed Description

The HError class is used to store an error code along with the location where the error ocurred (typically from the __FILE__ and __LINE__ macros).

Definition at line 166 of file HError.h.

Public Member Functions

 HError (ErrCode ec, StringPtr pstrFile, uint32 uLine)
ErrCode Reset (void)
 Clears the error information.
virtual const char * what (void) const throw ()
 Returns the error information as a readable string.
ErrCode SetInfo (ErrCode ec, StringPtr pstrFile, uint32 uLine, bool bNotify)
 Sets the error information.
bool IsError (void) const
 Returns true if this really is an error.
 operator ErrCode (void) const

Static Public Member Functions

static void Throw (ErrCode ec, StringPtr pstrFile, uint32 uLine) throw ()
 Sets information about the most recent error.
static HError & GetLastError (void)
 Returns the error object.
static ErrCode Set (ErrCode ec, StringPtr pstrFile, uint32 uLine)
 Sets information about the most recent error.
static ErrCode SetSilent (ErrCode ec, StringPtr pstrFile, uint32 uLine)
 Sets information about the most recent error.
static ErrCode NoError (void)
 Clears the last error.

Protected Attributes

ErrCode m_ec
 Numeric error code, or NO_ERROR (zero).
StringPtr m_pstrFile
 Ptr to source file (__FILE__).
uint32 m_uLine
 Line number in source file (__LINE__).

Static Protected Attributes

static HError theErr
 Global error instance.

Member Function Documentation

ErrCode HError::Reset (  void   ) 
 

Returns:
Always NO_ERROR

Definition at line 201 of file HError.h.

static void HError::Throw (  ErrCode  ec,
StringPtr  pstrFile,
uint32  uLine
)  throw () [static]
 

Parameters:
ec Error code
pstrFile Source file (__FILE__)
uLine Source line (__LINE__)

Definition at line 216 of file HError.h.

virtual const char* HError::what (  void   )  const throw () [virtual]
 

Returns:
String describing the error

Definition at line 227 of file HError.h.

static HError& HError::GetLastError (  void   )  [static]
 

Returns:
Error object

Definition at line 246 of file HError.h.

static ErrCode HError::Set (  ErrCode  ec,
StringPtr  pstrFile,
uint32  uLine
)  [static]
 

Returns:
Error code
Parameters:
ec Error code
pstrFile Source file (__FILE__)
uLine Source line (__LINE__)

Definition at line 259 of file HError.h.

static ErrCode HError::SetSilent (  ErrCode  ec,
StringPtr  pstrFile,
uint32  uLine
)  [static]
 

Returns:
Error code
Parameters:
ec Error code
pstrFile Source file (__FILE__)
uLine Source line (__LINE__)

Definition at line 269 of file HError.h.

ErrCode HError::SetInfo (  ErrCode  ec,
StringPtr  pstrFile,
uint32  uLine,
bool  bNotify
) 
 

Returns:
Error code
Parameters:
ec Error code
pstrFile Source file (__FILE__)
uLine Source line (__LINE__)
bNotify True to notify user, false otherwise

Definition at line 280 of file HError.h.

static ErrCode HError::NoError (  void   )  [static]
 

Returns:
Always NO_ERROR;

Definition at line 297 of file HError.h.

bool HError::IsError (  void   )  const
 

Returns:
True if error, false if NO_ERROR

Definition at line 301 of file HError.h.

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

2006.01.09-16:37