share/man/man3m/feholdexcept.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) 2006, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH FEHOLDEXCEPT 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  47 .SH NAME
  48 feholdexcept \- save current floating-point environment
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  53 #include <fenv.h>
  54
  55 \fBint\fR \fBfeholdexcept\fR(\fBfenv_t *\fR\fIenvp\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBfeholdexcept()\fR function saves the current floating-point environment
  62 in the object pointed to by \fIenvp\fR, clears the floating-point status flags,
  63 and then installs a non-stop (continue on floating-point exceptions) mode, if
  64 available, for all floating-point exceptions.
  65 .SH RETURN VALUES
  66 .sp
  67 .LP
  68 The \fBfeholdexcept()\fR function returns 0 if and only if non-stop
  69 floating-point exception handling was successfully installed.
  70 .SH ERRORS
  71 .sp
  72 .LP
  73 No errors are defined.
  74 .SH ATTRIBUTES
  75 .sp
  76 .LP
  77 See \fBattributes\fR(5) for descriptions of the following attributes:
  78 .sp
  79
  80 .sp
  81 .TS
  82 tab(    ) box;
  83 cw(2.75i) |cw(2.75i)
  84 lw(2.75i) |lw(2.75i)
  85 .
  86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  87 _
  88 Interface Stability     Standard
  89 _
  90 MT-Level        MT-Safe
  91 .TE
  92
  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBfegetenv\fR(3M), \fBfenv.h\fR(3HEAD), \fBfeupdateenv\fR(3M),
  97 \fBattributes\fR(5), \fBstandards\fR(5)
  98 .SH NOTES
  99 .sp
 100 .LP
 101 In a multithreaded program, the \fBfeholdexcept()\fR function affects the
 102 floating point environment only for the calling thread.
 103 .sp
 104 .LP
 105 The \fBfeholdexcept()\fR function automatically installs and deinstalls
 106 \fBSIGFPE\fR handlers and sets and clears the trap enable mode bits in the
 107 floating point status register as needed. If a program uses these functions and
 108 attempts to install a \fBSIGFPE\fR handler or control the trap enable mode bits
 109 independently, the resulting behavior is not defined.