libfossil
fsl_error Struct Reference

A container for storing generic error state. More...

#include "util.h"

Collaboration diagram for fsl_error:

Data Fields

int code
 Error code, generally assumed to be a fsl_rc_e value.
fsl_buffer msg
 Error message text is stored in this->msg.mem.

Detailed Description

A container for storing generic error state.

It is used to propagate error state between layers of the API back to the client. i.e. they act as basic exception containers.

See also
fsl_error_set()
fsl_error_get()
fsl_error_propagate()
fsl_error_clear()

Definition at line 781 of file util.h.

Field Documentation

◆ code

int fsl_error::code

Error code, generally assumed to be a fsl_rc_e value.

The "non-error" code is 0.

Definition at line 791 of file util.h.

◆ msg

fsl_buffer fsl_error::msg

Error message text is stored in this->msg.mem.

The usable text part is this->msg.used bytes long.

Definition at line 786 of file util.h.


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