Botan 3.0.0-alpha0
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::Invalid_Argument Class Reference

#include <exceptn.h>

Inheritance diagram for Botan::Invalid_Argument:
Botan::Exception Botan::Invalid_Algorithm_Name Botan::Invalid_IV_Length Botan::Invalid_Key_Length Botan::Pipe::Invalid_Message_Number

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::exception &e)
 Invalid_Argument (const std::string &msg, const std::string &where)
const char * what () const noexcept override

Detailed Description

An invalid argument was provided to an API call.

Definition at line 132 of file exceptn.h.

Constructor & Destructor Documentation

◆ Invalid_Argument() [1/3]

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

Definition at line 82 of file exceptn.cpp.

82 :
83 Exception(msg)
84 {}
Exception(const std::string &msg)
Definition: exceptn.cpp:71

◆ Invalid_Argument() [2/3]

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

Definition at line 86 of file exceptn.cpp.

86 :
87 Exception(msg + " in " + where)
88 {}

◆ Invalid_Argument() [3/3]

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

Definition at line 90 of file exceptn.cpp.

90 :
91 Exception(msg, e) {}

Member Function Documentation

◆ error_code()

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

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.

Reimplemented in Botan::Compression_Error, Botan_FFI::FFI_Error, Botan::CommonCrypto_Error, Botan::PKCS11::PKCS11_ReturnError, Botan::TLS::TLS_Exception, Botan::SQL_Database::SQL_DB_Error, and Botan::System_Error.

Definition at line 108 of file exceptn.h.

108{ return 0; }

◆ error_type()

ErrorType Botan::Invalid_Argument::error_type ( ) const

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

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

Definition at line 141 of file exceptn.h.

References Botan::InvalidArgument.

◆ what()

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

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 94 of file exceptn.h.

94{ return m_msg.c_str(); }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), and Botan_FFI::ffi_guard_thunk().

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