Botan 3.3.0
Crypto and TLS for C&
Public Member Functions | List of all members
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 2852 of file p11.h.

Constructor & Destructor Documentation

◆ PKCS11_ReturnError()

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

Definition at line 2854 of file p11.h.

2854 :
2855 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:2847

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

2859{ 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 2849 of file p11.h.

◆ get_return_value()

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

Definition at line 2857 of file p11.h.

2857{ 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 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: