QA·C Help - 3122

	3122	Hard-coded 'magic' string literal, %s.

Constants

A string literal has been used.

It may be better to define this string with a macro or a static constant (e.g. "static const char *"). Message 3122 will not be generated in these contexts and the definition can be located where it can more easily be reviewed and maintained - rather than buried within executable code. This is particularly important for maintainability if the same constant is reused in several places. Giving the constant a name may also improve readability.

For example:


/*PRQA S 2017,3218,3232,3408,3447,3602,3625,3627 ++*/

extern void func( const char * s );

#define WELCOME_MSG "hello"
static const char * agenda = "Today's agenda";

extern void foo( void )
{
    func( "Start-up procedure" );               /* Message 3122 */

    func( WELCOME_MSG );                        /* OK           */

    func( agenda );                             /* OK           */
}

See also:

3120 Hard-coded 'magic' integer constant, '%s'.
3121 Hard-coded 'magic' floating constant, '%s'.
3123 Hard coded 'magic' character constant, %s.
3131 Hard coded 'magic' number, '%s', used to define the size of a bit-field.
3132 Hard coded 'magic' number, '%s', used to define the size of an array.

Personality Groups | Glossary | Message Index

Contents