Avis Client Library: ElvinError Struct Reference

# ElvinError Struct Reference

`#include <avis/errors.h>`

## Detailed Description

Error reporting information for the Avis client library.

Functions in the library that may fail will use a pointer to an ElvinError instance to indicate, via an error code and message, if the function or any sub function fails. As a convenience, functions which would otherwise return void will often return true/false to indicate error status.

Note that the Elvin struct used for client connections contains an embedded error context that takes the place of an explicit error context parameter.

Example:

     ElvinError error = ELVIN_EMPTY_ERROR;

     function_that_may_fail (arg1, arg2, ..., &error);

     if (elvin_error_occurred (&error))
       elvin_perror ("error", &error);

     elvin_error_free (&error);

See also:
  elvin_error_set()

  elvin_error_ok()

  on_error_return_false()

  on_error_return()

## Data Fields
int | code
char * | message

## Field Documentation

int ElvinError::code

char* ElvinError::message

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

- avis/errors.h