liberror/doc/LIBERROR_ASSERT.autodoc

79 lines
957 B
Plaintext
Executable File

\section NAME
LIBEROR_ASSERT - report an error message to the stderr
\break
\section SYNOPSIS
\bold-on
#define LIBERROR_ASSERT(
\bold-off
\italics-on
expression
\italics-off
\bold-on
,
\space
\bold-off
\italics-on
type
\italics-off
\bold-on
,
\space
\bold-off
\italics-on
message
\italocs-off
\bold-on
,
\space
\italics-on
function
\italics-off
\bold-on
);
\bold-off
\break
\section DESCRIPTION
The LIBERROR_ASSERT macro will raise a runtime error of the type
\space
\italics-on
type
\italics-off
\space
\break
if the expression
\space
\italics-on
expression
\italics-off
\space
evaluates to false. The error will contain a
\break
message describing what happened, as well as the function that the
\break
error occurred in. The error will be written to the stderr in the
\break
format described in
\space
\bold-on
liberror
\bold-off
(cware).
\break
\break
\section SEE ALSO
\bold-on
cware
\bold-off
(cware),
\space
\bold-on
liberror
\bold-off
(cware)