Botan 3.5.0
Crypto and TLS for C&
Botan::PKCS11::PKCS11_ReturnError Class Referencefinal

#include <p11.h>

Inheritance diagram for Botan::PKCS11::PKCS11_ReturnError:
Botan::PKCS11::PKCS11_Error Botan::Exception

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 2854 of file p11.h.

Constructor & Destructor Documentation

◆ PKCS11_ReturnError()

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

Definition at line 2856 of file p11.h.

2856 :
2857 PKCS11_Error(std::to_string(static_cast<uint32_t>(return_val))), m_return_val(return_val) {}
PKCS11_Error(std::string_view what)
Definition p11.h:2849

Member Function Documentation

◆ error_code()

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

Definition at line 2861 of file p11.h.

2861{ return static_cast<int>(m_return_val); }

◆ error_type()

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

Return the "type" of error which occurred.

Reimplemented from Botan::Exception.

Definition at line 2851 of file p11.h.

◆ get_return_value()

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

Definition at line 2859 of file p11.h.

2859{ return m_return_val; }

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

93{ 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 file: