Crypto++ 8.1 Free C++ class library of cryptographic schemes

Public Types | Public Member Functions | List of all members
Exception Class Reference

Base class for all exceptions thrown by the library. More...

Inheritance diagram for Exception:

## Public Types
enum | ErrorType { NOT_IMPLEMENTED, INVALID_ARGUMENT, CANNOT_FLUSH, DATA_INTEGRITY_CHECK_FAILED, INVALID_DATA_FORMAT, IO_ERROR, OTHER_ERROR }
| Error types or categories. More...

## Public Member Functions
| Exception (ErrorType errorType, const std::string &s)
| Construct a new Exception.
const char * | what () const throw ()
| Retrieves a C-string describing the exception.
const std::string & | GetWhat () const
| Retrieves a string describing the exception.
void | SetWhat (const std::string &s)
| Sets the error string for the exception.
ErrorType | GetErrorType () const
| Retrieves the error type for the exception.
void | SetErrorType (ErrorType errorType)
| Sets the error type for the exceptions.

## Detailed Description

Base class for all exceptions thrown by the library.

All library exceptions directly or indirectly inherit from the Exception class. The Exception class itself inherits from std::exception. The library does not use std::runtime_error derived classes.

Definition at line 158 of file cryptlib.h.

## Member Enumeration Documentation

## ◆ ErrorType

enum Exception::ErrorType

Error types or categories.

Enumerator
NOT_IMPLEMENTED | A method was called which was not implemented.
INVALID_ARGUMENT | An invalid argument was detected.
CANNOT_FLUSH | BufferedTransformation received a Flush(true) signal but can't flush buffers.
DATA_INTEGRITY_CHECK_FAILED | Data integerity check, such as CRC or MAC, failed.
INVALID_DATA_FORMAT | Input data was received that did not conform to expected format.
IO_ERROR | Error reading from input device or writing to output device.
OTHER_ERROR | Some other error occurred not belonging to other categories.

Definition at line 163 of file cryptlib.h.

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

- cryptlib.h