Gleb Klochkov / Mbed OS Climatcontroll_Main

Dependencies:   esp8266-driver

Embed: (wiki syntax)

« Back to documentation index

Error functions

Error functions
[Platform]

Functions

void error (const char *format,...)
 To generate a fatal compile-time error, you can use the pre-processor error directive.

Function Documentation

void error ( const char *  format,
  ... 
)

To generate a fatal compile-time error, you can use the pre-processor error directive.

Parameters:
formatC string that contains data stream to be printed. Code snippets below show valid format.
 #error "That shouldn't have happened!"

If the compiler evaluates this line, it will report the error and stop the compile.

For example, you could use this to check some user-defined compile-time variables:

 #define NUM_PORTS 7
 #if (NUM_PORTS > 4)
     #error "NUM_PORTS must be less than 4"
 #endif

Reporting Run-Time Errors: To generate a fatal run-time error, you can use the mbed error() function.

 error("That shouldn't have happened!");

If the mbed running the program executes this function, it will print the message via the USB serial port, and then die with the blue lights of death!

The message can use printf-style formatting, so you can report variables in the message too. For example, you could use this to check a run-time condition:

 if(x >= 5) {
     error("expected x to be less than 5, but got %d", x);
 }

Definition at line 28 of file mbed_error.c.