LANG.PREPROC.ERROR : Use of #error

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

A use of the #error preprocessor directive.

Many coding standards forbid the use of #error because it makes code harder for human readers to understand.

Class Name

Use of #error

Significance

style

Mnemonic

LANG.PREPROC.ERROR

Categories

AUTOSARC++14	AUTOSARC++14:A16-0-1	The pre-processor shall only be used for unconditional and conditional file inclusion and include guards, and using the following directives: (1) #ifndef, (2) #ifdef, (3) #if, (4) #if defined, (5) #elif, (6) #else, (7) #define, (8) #endif, (9) #include.
	AUTOSARC++14:A16-6-1	#error directive shall not be used.
CWE	CWE:1076	Insufficient Adherence to Expected Conventions
JSF++	JSF++:26	Only the following pre-processor directives shall be used: #ifndef, #define, #endif, #include.
POW10	POW10:8	Limit the use of the preprocessor to file inclusion and simple macros.

Availability

Available for C and C++.

Enabling

Checks for this warning class are disabled by default. To enable them, add the following WARNING_FILTER rule to the project configuration file.

WARNING_FILTER += allow class="Use of #error"

#ifndef __FILE__                        /* ('Use of #ifndef' warning issued here if enabled) */

#error "Something unexpected" /* 'Use of #error' warning issued here */
#endif                                  /* ('Use of #endif' warning issued here if enabled) */

The following configuration file parameters affect checks for this warning class.

LANG.PREPROC.ERROR : Use of #error

Summary

Properties

Example

Relevant Configuration File Parameters