ErrorLib 1.0.14-master SHA: 787260c7d1
Help-texts in Errors

Help-texts in the error definition or in error-reactions are given as two separate arguments for English and German. The German text is optional; if it is omitted, the English one is shown instead. Any html code can be used in the text to structurize the help-page. The following macros can be used:

  • DEFINE_VAL(x) - The value of the defines x is shown in the text.
  • PARA(x) - Link to a parameter with the identifier x. In the helptext the name of the parameter and the actual formatted value is shown. On a click onto this, the parametereditor jumps to the linked parameter.
  • ERROR(x) - Link to the error with identifier x. In the helptext the errortext is shown.

Example for an error reaction with a link:

DefineOnErrorReaction(TestErrorReaction, // Function to be called
"Test Error Reaction", // Name of the function
/ * ---- English Help: ---- * /
"Test Error-Reaction. Link to Parameter Identification "PARA(PARA_ID_Identifikation)". "
"Blah blah.",
/ * ---- German Help: ---- * /
"Dies ist eine Testbeschreibung. Verweis auf den "PARA(PARA_ID_Identifikation)". "
"Blah blah.")
DefineOnErrorReaction(TestErrorReaction, "Test Error Reaction", "Test Error-Reaction. Link to Parameter Identification "PARA_STR(PARA_ID_Identifikation)". " "Blah blah.", "Dies ist eine Testbeschreibung. Verweis auf den "PARA_STR(PARA_ID_Identifikation)". " "Blah blah.")
Definition of a sample Error-Reaction.
Definition: Sample_Errors.c:22