usr/src/man/man3m/fegetexceptflag.3m

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH FEGETEXCEPTFLAG 3M "Sep 1, 2002" "SunOS 5.11" "Mathematical Library Functions"
  47 .SH NAME
  48 fegetexceptflag, fesetexceptflag \- get and set floating-point status flags
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  53 #include <fenv.h>
  54
  55 \fBint\fR \fBfegetexceptflag\fR(\fBfexcept_t *\fR\fIflagp\fR, \fBint\fR \fIexcepts\fR);
  56 .fi
  57
  58 .LP
  59 .nf
  60 \fBint\fR \fBfesetexceptflag\fR(\fBconst fexcept_t *\fR\fIflagp\fR, \fBint\fR \fIexcepts\fR);
  61 .fi
  62
  63 .SH DESCRIPTION
  64 .sp
  65 .LP
  66 The \fBfegetexceptflag()\fR function attempts to store an
  67 implementation-defined representation of the states of the floating-point
  68 status flags indicated by the \fIexcepts\fR argument in the object pointed to
  69 by the \fIflagp\fR argument.
  70 .sp
  71 .LP
  72 The \fBfesetexceptflag()\fR function attempts to set the floating-point status
  73 flags indicated by the \fIexcepts\fR argument to the states stored in the
  74 object pointed to by \fIflagp\fR. The value pointed to by \fIflagp\fR will have
  75 been set by a previous call to \fBfegetexceptflag()\fR whose second argument
  76 represented at least those floating-point exceptions represented by the
  77 \fIexcepts\fR argument. This function does not raise floating-point exceptions
  78 but only sets the state of the flags.
  79 .SH RETURN VALUES
  80 .sp
  81 .LP
  82 If the representation was successfully stored, \fBfegetexceptflag()\fR returns
  83 0. Otherwise, it returns a non-zero value.
  84 .sp
  85 .LP
  86 If the excepts argument is 0 or if all the specified exceptions were
  87 successfully set, \fBfesetexceptflag()\fR returns 0. Otherwise, it returns a
  88 non-zero value.
  89 .SH ERRORS
  90 .sp
  91 .LP
  92 No errors are defined.
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 tab(    ) box;
 102 cw(2.75i) |cw(2.75i)
 103 lw(2.75i) |lw(2.75i)
 104 .
 105 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 106 _
 107 Interface Stability     Standard
 108 _
 109 MT-Level        MT-Safe
 110 .TE
 111
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBfenv.h\fR(3HEAD), \fBfeclearexcept\fR(3M), \fBferaiseexcept\fR(3M),
 116 \fBfesetexceptflag\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)