man-pages/man3/assert_perror.3.html
2021-03-31 01:06:50 +01:00

132 lines
3.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of ASSERT_PERROR</TITLE>
</HEAD><BODY>
<H1>ASSERT_PERROR</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
assert_perror - test errnum and abort
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#define _GNU_SOURCE</B> /* See <A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A>(7) */
<B>#include &lt;<A HREF="file:///usr/include/assert.h">assert.h</A>&gt;</B>
<B>void assert_perror(int </B><I>errnum</I><B>);</B>
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
If the macro
<B>NDEBUG</B>
was defined at the moment
<I>&lt;<A HREF="file:///usr/include/assert.h">assert.h</A>&gt;</I>
was last included, the macro
<B>assert_perror</B>()
generates no code, and hence does nothing at all.
Otherwise, the macro
<B>assert_perror</B>()
prints an error message to standard error and terminates the program
by calling
<B><A HREF="/cgi-bin/man/man2html?3+abort">abort</A></B>(3)
if
<I>errnum</I>
is nonzero.
The message contains the filename, function name and
line number of the macro call, and the output of
<I>strerror(errnum)</I>.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
No value is returned.
<A NAME="lbAF">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>assert_perror</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>CONFORMING TO</H2>
This is a GNU extension.
<A NAME="lbAH">&nbsp;</A>
<H2>BUGS</H2>
The purpose of the assert macros is to help programmers find bugs in
their programs, things that cannot happen unless there was a coding mistake.
However, with system or library calls the situation is rather different,
and error returns can happen, and will happen, and should be tested for.
Not by an assert, where the test goes away when
<B>NDEBUG</B>
is defined,
but by proper error handling code.
Never use this macro.
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+abort">abort</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+assert">assert</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+exit">exit</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+strerror">strerror</A></B>(3)
<A NAME="lbAJ">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="5"><A HREF="#lbAF">ATTRIBUTES</A><DD>
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
<DT id="7"><A HREF="#lbAH">BUGS</A><DD>
<DT id="8"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="9"><A HREF="#lbAJ">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:35 GMT, March 31, 2021
</BODY>
</HTML>