retdec-cpp
Public Member Functions | List of all members
retdec::ApiError Class Reference

Exception thrown when the API is used incorrectly. More...

#include <exceptions.h>

Inheritance diagram for retdec::ApiError:
retdec::Error retdec::AuthError

Public Member Functions

 ApiError (int code, const std::string &message, const std::string &description="")
 Creates an exception. More...
 
int getCode () const noexcept
 Returns the error code. More...
 
std::string getMessage () const
 Returns a short message describing the error. More...
 
std::string getDescription () const
 Returns a full description of the error (if any). More...
 

Detailed Description

Exception thrown when the API is used incorrectly.

Constructor & Destructor Documentation

retdec::ApiError::ApiError ( int  code,
const std::string &  message,
const std::string &  description = "" 
)

Creates an exception.

Parameters
[in]codeError code.
[in]messageShort message describing the error.
[in]descriptionFull description of the error.

Member Function Documentation

int retdec::ApiError::getCode ( ) const
noexcept

Returns the error code.

std::string retdec::ApiError::getDescription ( ) const

Returns a full description of the error (if any).

If there is no description, it returns the same value as what().

std::string retdec::ApiError::getMessage ( ) const

Returns a short message describing the error.


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