NAME [edit section]

= NAME =
eprint

SYNOPSIS [edit section]

= SYNOPSIS =
 * eprint "message"

DESCRIPTION [edit section]

= DESCRIPTION =
This function outputs the message, always.  That is, the message
is output no matter what the log level. This function should be used
to indicate a fatal condition that
requires user consideration or action.

Shell variable values can be output as part of the message.

This routine will add an extra prefix to the message, to draw attention to
this message in the console log for the test run.  The prefix is:
"!!! ERROR:".

EXAMPLES [edit section]

= EXAMPLES =
Here is a sample invocation:
{{{#!YellowBox
    eprint "Cannot write to disk -- cannot continue"
}}}

This would output:

!!! ERROR: Cannot write to disk -- cannot continue
}}}

{{{
!!! ERROR: Cannot write to disk -- cannot continue
}}}

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
None

RETURN [edit section]

= RETURN =
Returns 0

SOURCE [edit section]

= SOURCE =
Located in ''scripts/common.sh''

SEE ALSO [edit section]

= SEE ALSO =
 * [[function_dprint|dprint]], [[function_vprint|vprint]], [[function_iprint|iprint]], [[function_wprint|wprint]]