RetVal - ReferenceΒΆ

class ito::RetVal

Class for error value management.

The RetVal class is used for handling return codes. All classes should use this class. In case an error occurs, only the first error is stored and will not be overridden by potentially subsequent occurring errors.

Public Functions

RetVal(ito::tRetValue retValue, int retCode, const char * pRetMessage)

constructor with retValue, retCode and errorMessage

Parameters
  • retValue -

    type of RetVal; for possible values see tRetValue

  • retCode -

    user definable return code

  • pRetMessage -

    error message to be passed or NULL, string is copied Makes a deep copy of RetVal, i.e. a copy of the error message

RetVal & operator=(const RetVal & rhs)

assignment operator, copies values of rhs to current RetVal. Before copiing current errorMessage is freed

RetVal & operator+=(const RetVal & rhs)

Concatenation of RetVal “Adds” RetVals, i.e. returns the most serious error. In case of equally serious errors the first is retained

RetVal operator+(const RetVal & rhs)

Concatenation of RetVal See operator RetVal::operator+=

char operator==(const RetVal & rhs)

equality operator compares retValue with with retValue of rhs RetVal. For possible constant values see tRetValue

char operator!=(const RetVal & rhs)

unequality operator compares retValue with with retValue of rhs RetVal. For possible constant values see tRetValue

char operator==(const tRetValue rhs)

equality operator compares retValue with tRetValue constant. For possible constant values see tRetValue

char operator!=(const tRetValue rhs)

unequality operator compares retValue with tRetValue constant. For possible constant values see tRetValue

int containsWarning() const

checks if any warning has occurred in this return value (true), else (false)

int containsError() const

checks if any error has occurred in this return value (true), else (false)

int containsWarningOrError() const

checks if any warning or error has occurred in this return value (true), else (false)

const char * errorMessage() const

returns zero-terminated error message or empty, zero-terminated string if no error message has been set