VW::experimental::api_status Class Reference

Report status of all API calls. More...

#include <api_status.h>

Public Member Functions
	api_status ()
int	get_error_code () const
	(api_error_codes) Get the error code All API calls will return a status code. If the optional api_status object is passed in, the code is set in the object also. More...
const char *	get_error_msg () const
	(api_error_codes) Get the error msg string All API calls will return a status code. If the optional api_status object is passed in, the detailed error description is passed back using get_error_msg() More...

Static Public Member Functions
static void	try_update (api_status *status, int new_code, const char *new_msg)
	Helper method for returning error object Checks to see if api_status is not null before setting the error code and error message. More...
static void	try_clear (api_status *status)
	Helper method to clear the error object Checks to see if api_status is not null before clearing current values. More...

Detailed Description

Report status of all API calls.

Constructor & Destructor Documentation

VW::experimental::api_status::api_status

(

)

Member Function Documentation

int VW::experimental::api_status::get_error_code

(

)

const

(api_error_codes) Get the error code All API calls will return a status code. If the optional api_status object is passed in, the code is set in the object also.

Returns

int Error code

const char* VW::experimental::api_status::get_error_msg

(

)

const

(api_error_codes) Get the error msg string All API calls will return a status code. If the optional api_status object is passed in, the detailed error description is passed back using get_error_msg()

Returns

const char* Error description

static void VW::experimental::api_status::try_clear ( api_status *  status )

static

Helper method to clear the error object Checks to see if api_status is not null before clearing current values.

Parameters

status

Error object. Could be null.

static void VW::experimental::api_status::try_update ( api_status *  status, int  new_code, const char *  new_msg  )

static

Helper method for returning error object Checks to see if api_status is not null before setting the error code and error message.

Parameters

status	Error object. Could be null.
new_code	Error code to set if status object is not null
new_msg	Error description to set if status object is not null

---

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

• /__w/vowpal_wabbit/vowpal_wabbit/vowpalwabbit/api_status.h