Error checking

Files
file	check.h
	Header file for configurable error checking.

Macros
#define	CHECKIF(expr)
	Guard error-handling code with a configurable check.

Detailed Description

Since

2.2

Version

1.0.0

Macro Definition Documentation

CHECKIF

#define CHECKIF

(

expr

)

#include <zephyr/sys/check.h>

Value:

if (expr)

Guard error-handling code with a configurable check.

Wrap a condition that evaluates to true when an error is detected, and a statement or block to run when that condition holds.

CHECKIF(dev == NULL) {
    return -EINVAL;
}

The behavior is configurable using Kconfig:

• CONFIG_RUNTIME_ERROR_CHECKS (default) expands to if (expr)
• CONFIG_ASSERT_ON_ERRORS asserts, the guarded block is not run
• CONFIG_NO_RUNTIME_CHECKS checks are omitted at compile time

Parameters

expr	Error condition expression.