---------------------------------------------------------------------
CLASS: Error --JD,DVM,AP
PUBLIC METHODS:
Error() (inline) - Constructor from ErrorCodeType.
Default is error_None.
operator=() (inline) - Assigns from ErrorCodeType.
operator==() (inline) - Compares with ErrorCodeType.
message() - Returns a CHAR_PTR for error message
Casting operators:
INT32() (inline) - Only needed by G++.
ErrorCodeType() (inline) - Enough for most compilers
USAGE NOTES:
Cast to INT32 allows very simple testing for any error and no
error. See notes for ErrorCodeType enum.
----------------------------------------------------------------------
---------------------------------------------------------------------
METHOD: Error::message --JD,AP
Returns a const CHAR_PTR to the an Ascii representation of current
value.
ARGS: none.
RETURNS:
CONST_CHAR_PTR to message.
PRE-CONDITIONS: none.
POST-CONDITIONS: none.
ERRORS: none.
NOTES:
This performs a lookup into a table associating error messages to
error values (see ErrorCodeType). If the value does not have an
entry in the table, the string indicates this as well, with:
"An unknown error occurred"
If this happens, it is most likely that there is an inconsistency
between the sys/nsrError.h and sys/nsrError.cpp files.
----------------------------------------------------------------------
---------------------------------------------------------------------
METHOD: Error::message --JD,AP
Returns a const CHAR_PTR to the an Ascii representation of current
value.
ARGS: none.
RETURNS:
CONST_CHAR_PTR to message.
PRE-CONDITIONS: none.
POST-CONDITIONS: none.
ERRORS: none.
NOTES:
This performs a lookup into a table associating error messages to
error values (see ErrorCodeType). If the value does not have an
entry in the table, the string indicates this as well, with:
"An unknown error occurred"
If this happens, it is most likely that there is an inconsistency
between the sys/nsrError.h and sys/nsrError.cpp files.
----------------------------------------------------------------------
NSR::CONST_CHAR_PTR
NSR::Error::message() const