usr/src/man/man3c/assert.3c

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 2005, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ASSERT 3C "Mar 30, 2005"
   7 .SH NAME
   8 assert \- verify program assertion
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <assert.h>
  13
  14 \fBvoid\fR \fBassert\fR(\fBint\fR \fIexpression\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBassert()\fR macro inserts diagnostics into applications. When executed,
  21 if \fIexpression\fR is \fBFALSE\fR (zero), \fBassert()\fR prints the error
  22 message
  23 .sp
  24 .in +2
  25 .nf
  26 Assertion failed: \fIexpression\fR, file \fIxyz\fR, line \fInnn\fR
  27 .fi
  28 .in -2
  29
  30 .sp
  31 .LP
  32 on the standard error output and aborts. In the error message, \fIxyz\fR is the
  33 name of the source file and \fInnn\fR the source line number of the
  34 \fBassert()\fR statement. These are respectively the values of the preprocessor
  35 macros \fB__FILE__\fR and \fB__LINE__\fR.
  36 .sp
  37 .LP
  38 Since \fBassert()\fR is implemented as a macro, the \fIexpression\fR may not
  39 contain any string literals.
  40 .sp
  41 .LP
  42 Compiling with the preprocessor option \fB\fR\fB-DNDEBUG\fR or with the
  43 preprocessor control statement \fB#define NDEBUG\fR ahead of the \fB#include\fR
  44 <\fBassert.h\fR> statement, will stop assertions from being compiled into the
  45 program.
  46 .sp
  47 .LP
  48 Messages printed from this function are in the native language specified by the
  49 \fBLC_MESSAGES\fR locale category. See \fBsetlocale\fR(3C).
  50 .SH ATTRIBUTES
  51 .sp
  52 .LP
  53 See \fBattributes\fR(5) for descriptions of the following attributes:
  54 .sp
  55
  56 .sp
  57 .TS
  58 box;
  59 c | c
  60 l | l .
  61 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  62 _
  63 Interface Stability     Committed
  64 _
  65 MT-Level        Safe
  66 _
  67 Standard        See \fBstandards\fR(5).
  68 .TE
  69
  70 .SH SEE ALSO
  71 .sp
  72 .LP
  73 \fBabort\fR(3C), \fBgettext\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5),
  74 \fBstandards\fR(5)