ErrorLib 1.0.14-master SHA: 787260c7d1
tError Struct Reference

Main error structure. More...

#include <Error.h>

Data Fields

const uint16_t ui16Id
 Error-ID. More...
 
const uint16_t ui16DataCount
 Number of attached variables (not byte). See Details on Page Data appended to errors. More...
 
const uint32_t ui32Flags
 Flags from enum ERROR_FLAGS e.g. error reset permissions. More...
 
const char * Description
 Short Description of the error. More...
 
const uint32_t ui32DescriptionLength
 Strlen of Description. More...
 
const char * Help
 Long help text explaining the cause and maybe how to solve the error. See Page Help-texts in Errors for details. More...
 
const uint32_t ui32HelpLength
 Strlen of Help. More...
 
const tOnErrorReaction * OnError
 Function to be called on first time setting the error. See Page Actions on Error set and reset for details. More...
 
const tOnErrorResetReaction * OnErrorReset
 Function to be called on reseting the error. See Page Actions on Error set and reset for details. More...
 

Detailed Description

Main error structure.

Field Documentation

◆ Description

const char* Description

Short Description of the error.

◆ Help

const char* Help

Long help text explaining the cause and maybe how to solve the error. See Page Help-texts in Errors for details.

◆ OnError

const tOnErrorReaction* OnError

Function to be called on first time setting the error. See Page Actions on Error set and reset for details.

◆ OnErrorReset

const tOnErrorResetReaction* OnErrorReset

Function to be called on reseting the error. See Page Actions on Error set and reset for details.

◆ ui16DataCount

const uint16_t ui16DataCount

Number of attached variables (not byte). See Details on Page Data appended to errors.

◆ ui16Id

const uint16_t ui16Id

Error-ID.

◆ ui32DescriptionLength

const uint32_t ui32DescriptionLength

Strlen of Description.

◆ ui32Flags

const uint32_t ui32Flags

Flags from enum ERROR_FLAGS e.g. error reset permissions.

◆ ui32HelpLength

const uint32_t ui32HelpLength

Strlen of Help.


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