File error.h

FileList > docs > sandwich_c > error.h

Go to the source code of this file

Error handling for the Sandwich library.

• #include "sandwich_c/error_codes.h"
• #include "sandwich_c/export.h"

Classes

Type	Name
struct	SandwichError An error code.

Public Functions

Type	Name
SANDWICH_API void	sandwich_error_free (struct SandwichError * chain) Free an error chain.
SANDWICH_API void	sandwich_error_stack_str_free (const char * err_str) Free a an error string (generated from sandwich_error_stack_str_new)
SANDWICH_API char *	sandwich_error_stack_str_new (const struct SandwichError * chain) Create an error stack string from a SandwichError chain.

Public Functions Documentation

function sandwich_error_free

Free an error chain.

SANDWICH_API void sandwich_error_free (
    struct SandwichError * chain
) 

Parameters:

• chain Error chain.

function sandwich_error_stack_str_free

Free a an error string (generated from sandwich_error_stack_str_new)

SANDWICH_API void sandwich_error_stack_str_free (
    const char * err_str
) 

Parameters:

• err_str Pointer to error string to free.

NULL for err_str is allowed.

function sandwich_error_stack_str_new

Create an error stack string from a SandwichError chain.

SANDWICH_API char * sandwich_error_stack_str_new (
    const struct SandwichError * chain
) 

Parameters:

• chain Error chain.

Returns:

A NUL terminated string describing the SandwichError chain

---

The documentation for this class was generated from the following file docs/sandwich_c/error.h