BxObject Class Reference

Base class implementing error logs for all BinX library classes. More...

#include <BxObject.h>

Inheritance diagram for BxObject:

List of all members.

Public Member Functions
int	getErrorCode ()
char *	getErrorMessage () const

---

Detailed Description

This class implements operations to log errors. A set of error codes are defined for use by all BinX library classes.
This class may be deprecated in later version of the BinX library to improve performance.
Since: BinX version 1.0.

---

Member Function Documentation

int BxObject::getErrorCode (   )

Get and clear the current value of the global error code. The current global error code is the value set by the most recent method that detected and logged an error. The global error code stores a single value that is overwritten each time a method logs an error. Upon completion of this method, the global error code value is reset to zero. Returns: The current value of the global BinX library error code.

char * BxObject::getErrorMessage (   )  const

Get a pre-defined error message corresponding to the current value of the global error code. Pre-defined error messages are mapped by error code. The current value of the global error code for the BinX library is used to select the appropriate error message. Returns: A string pointer to the selected error message.

---

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

• BxObject.h
• BxObject.cpp

---