libpressio 0.93.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
pressio_errorable Class Reference

#include <errorable.h>

Inheritance diagram for pressio_errorable:
Inheritance graph
[legend]

Public Member Functions

const char * error_msg () const
 
int error_code () const
 

Protected Member Functions

int set_error (int code, std::string const &msg)
 
void clear_error ()
 

Detailed Description

class that indicates that a pressio object handles errors

Member Function Documentation

◆ clear_error()

void pressio_errorable::clear_error ( )
protected

clears the error code and resets the error message

◆ error_code()

int pressio_errorable::error_code ( ) const

get the error code for the last error

Returns
an implementation specific integer error code for the last error, 0 is reserved for no error

◆ error_msg()

const char * pressio_errorable::error_msg ( ) const

get the error message for the last error

Returns
an implementation specific c-style error message for the last error

◆ set_error()

int pressio_errorable::set_error ( int  code,
std::string const &  msg 
)
protected

Should be used by implementing plug-ins to provide error codes

Parameters
[in]codea implementation specific code for the last error
[in]msga implementation specific message for the last error
Returns
the value passed to code

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