Botan  2.9.0
Crypto and TLS for C++11
Public Member Functions | List of all members
Botan::Invalid_Argument Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::Invalid_Argument:
Botan::Exception Botan::BigInt::DivideByZero Botan::Decoding_Error Botan::Encoding_Error Botan::Invalid_Algorithm_Name Botan::Invalid_IV_Length Botan::Invalid_Key_Length Botan::Pipe::Invalid_Message_Number Botan::Unsupported_Argument

Public Member Functions

virtual int error_code () const noexcept
 
ErrorType error_type () const noexcept override
 
 Invalid_Argument (const std::string &msg)
 
 Invalid_Argument (const std::string &msg, const std::string &where)
 
 Invalid_Argument (const std::string &msg, const std::exception &e)
 
const char * what () const noexcept override
 

Detailed Description

An invalid argument was provided to an API call.

Definition at line 117 of file exceptn.h.

Constructor & Destructor Documentation

◆ Invalid_Argument() [1/3]

Botan::Invalid_Argument::Invalid_Argument ( const std::string &  msg)
explicit

Definition at line 22 of file exceptn.cpp.

22  :
23  Exception(msg)
24  {}
Exception(const std::string &msg)
Definition: exceptn.cpp:11

◆ Invalid_Argument() [2/3]

Botan::Invalid_Argument::Invalid_Argument ( const std::string &  msg,
const std::string &  where 
)
explicit

Definition at line 26 of file exceptn.cpp.

26  :
27  Exception(msg + " in " + where)
28  {}
Exception(const std::string &msg)
Definition: exceptn.cpp:11

◆ Invalid_Argument() [3/3]

Botan::Invalid_Argument::Invalid_Argument ( const std::string &  msg,
const std::exception &  e 
)

Definition at line 30 of file exceptn.cpp.

30  :
31  Exception(msg, e) {}
Exception(const std::string &msg)
Definition: exceptn.cpp:11

Member Function Documentation

◆ error_code()

virtual int Botan::Exception::error_code ( ) const
inlinevirtualnoexceptinherited

Return an error code associated with this exception, or otherwise 0.

The domain of this error varies depending on the source, for example on POSIX systems it might be errno, while on a Windows system it might be the result of GetLastError or WSAGetLastError. For error_type() is OpenSSLError, it will (if nonzero) be an OpenSSL error code from ERR_get_error.

Reimplemented in Botan::System_Error, Botan::Compression_Error, Botan::OpenSSL_Error, Botan::CommonCrypto_Error, Botan::TLS::TLS_Exception, and Botan_FFI::FFI_Error.

Definition at line 103 of file exceptn.h.

103 { return 0; }

◆ error_type()

ErrorType Botan::Invalid_Argument::error_type ( ) const
inlineoverridevirtualnoexcept

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Reimplemented in Botan::Decoding_Error, Botan::Encoding_Error, Botan::Invalid_IV_Length, and Botan::Invalid_Key_Length.

Definition at line 126 of file exceptn.h.

References Botan::InvalidArgument.

◆ what()

const char* Botan::Exception::what ( ) const
inlineoverridenoexceptinherited

Return a descriptive string which is hopefully comprehensible to a developer. It will likely not be useful for an end user.

The string has no particular format, and the content of exception messages may change from release to release. Thus the main use of this function is for logging or debugging.

Definition at line 87 of file exceptn.h.

Referenced by Botan::RSA_PrivateKey::create_decryption_op(), Botan::RSA_PublicKey::create_encryption_op(), and Botan_FFI::ffi_guard_thunk().

87 { return m_msg.c_str(); }

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