pd.if.org Git - pdclib.old/blob - man3/assert.3

   1 .\" This file is part of the Public Domain C Library (PDCLib).\r
   2 .\" Permission is granted to use, modify, and / or redistribute at will.\r
   3 .\"\r
   4 .Dd\r
   5 .Dt assert 3\r
   6 .Os\r
   7 .\"\r
   8 .Sh NAME\r
   9 .Nm assert\r
  10 .Nd validate assertion\r
  11 .\"\r
  12 .Sh SYNOPSIS\r
  13 .In assert.h\r
  14 .Fn "void assert" "<scalar expression>"\r
  15 .\"\r
  16 .Sh DESCRIPTION\r
  17 If\r
  18 .Dv NDEBUG\r
  19 was defined when\r
  20 .In assert.h\r
  21 was last included, the macro\r
  22 .Nm\r
  23 results in no code being generated. Otherwise, if the expression evaluates to \r
  24 false, an error message is printed to \r
  25 .Va stderr\r
  26 and execution is terminated by invoking\r
  27 .Fn abort .\r
  28 .Sh IMPLEMENTATION NOTES\r
  29 The enclosing function of the call to\r
  30 .Nm\r
  31 will only be printed in the error message when compiling for C99, or a later\r
  32 revision of the C standard. \r
  33 .\"\r
  34 .Sh SEE ALSO\r
  35 .Xr _Exit 3\r
  36 .Xr quick_exit 3\r
  37 .Xr exit 3\r
  38 .Xr abort 3\r
  39 .\"\r
  40 .Sh STANDARDS\r
  41 Conforming to\r
  42 .St -isoC-90 ,\r
  43 .St -isoC-99 .