Botan::PKCS11::PKCS11_ReturnError Class Reference

#include <p11.h>

Inheritance diagram for Botan::PKCS11::PKCS11_ReturnError:

Public Member Functions
int	error_code () const noexcept override
ErrorType	error_type () const noexcept override
ReturnValue	get_return_value () const
	PKCS11_ReturnError (ReturnValue return_val)
const char *	what () const noexcept override

Detailed Description

Definition at line 4020 of file p11.h.

Constructor & Destructor Documentation

PKCS11_ReturnError()

Botan::PKCS11::PKCS11_ReturnError::PKCS11_ReturnError ( ReturnValue return_val )

explicit

Definition at line 232 of file p11_error.cpp.

                                                             :
      PKCS11_Error(Botan::fmt("{} ({})", static_cast<uint32_t>(return_val), to_string(return_val))),
      m_return_val(return_val) {}

References Botan::fmt(), Botan::PKCS11::PKCS11_Error::PKCS11_Error(), and Botan::to_string().

Member Function Documentation

error_code()

int Botan::PKCS11::PKCS11_ReturnError::error_code ( ) const

inlineoverridevirtualnoexcept

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 from Botan::Exception.

Definition at line 4026 of file p11.h.

{ return static_cast<int>(m_return_val); }

error_type()

ErrorType Botan::PKCS11::PKCS11_Error::error_type ( ) const

inlineoverridevirtualnoexceptinherited

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Definition at line 4017 of file p11.h.

{ return ErrorType::Pkcs11Error; }

References Botan::Pkcs11Error.

get_return_value()

ReturnValue Botan::PKCS11::PKCS11_ReturnError::get_return_value ( ) const

inline

Definition at line 4024 of file p11.h.

{ return m_return_val; }

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

{ return m_msg.c_str(); }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::CommonCrypto_Error::CommonCrypto_Error(), Botan::CommonCrypto_Error::CommonCrypto_Error(), Exception(), Botan_FFI::FFI_Error::FFI_Error(), Botan_FFI::ffi_guard_thunk(), Botan::PKCS11::PKCS11_Error::PKCS11_Error(), Botan::SQL_Database::SQL_DB_Error::SQL_DB_Error(), Botan::SQL_Database::SQL_DB_Error::SQL_DB_Error(), Botan::TLS::Callbacks::tls_ephemeral_key_agreement(), Botan::TLS::Callbacks::tls_kem_encapsulate(), and Botan::X509_Certificate::to_string().

---

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

• src/lib/prov/pkcs11/p11.h
• src/lib/prov/pkcs11/p11_error.cpp