Class Error

Class Documentation

class Error

Error status reported by client API.

Public Functions

Error(const std::string &msg = "")

Create an error with the specified message.

Parameters

  • msg: The message for the error

const std::string &Message() const

Accessor for the message of this error.

Return

The messsage for the error. Empty if no error.

bool IsOk() const

Does this error indicate OK status?

Return

True if this error indicates “ok”/”success”, false if error indicates a failure.

Public Static Attributes

const Error Success

Convenience “success” value.

Can be used as Error::Success to indicate no error.