ArExitErrorSource Class Reference

Small interface for obtaining exit-on-error information. More...

#include <ArExitErrorSource.h>

Public Member Functions
	ArExitErrorSource ()
	Constructor.
virtual int	getExitErrorCode () const =0
	Returns the error code used for the exit call. More...
virtual bool	getExitErrorDesc (char *buf, int bufLen)=0
	Returns a textual description of the error source. More...
virtual	~ArExitErrorSource ()
	Destructor.

Detailed Description

Small interface for obtaining exit-on-error information.

ArExitErrorSource may be implemented by classes that wish to provide information if and when they cause an erroneous application exit. The use of this interface is entirely at the discretion of the application. Aria does not invoke its methods.

Member Function Documentation

getExitErrorCode()

virtual int ArExitErrorSource::getExitErrorCode ( ) const

pure virtual

Returns the error code used for the exit call.

Ideally, the returned error code should be unique across all error sources. (Past implementations have the method spec and body on a single line so that it's easily searchable... Current implementations have that OR this string on a line so that it'll show up searchable easily still).

getExitErrorDesc()

virtual bool ArExitErrorSource::getExitErrorDesc ( char *  buf, int  bufLen  )

pure virtual

Returns a textual description of the error source.

Parameters

buf	a char array in which the method puts the output error description
bufLen	the int number of char's in the array

Returns

bool true if the description was successfully written; false if an error occurred

---

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

• ArExitErrorSource.h