xref: /illumos-gate/usr/src/man/man3m/fegetexceptflag.3m (revision dd72704bd9e794056c558153663c739e2012d721)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

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.
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 the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.

FEGETEXCEPTFLAG 3M "Sep 1, 2002" "SunOS 5.11" "Mathematical Library Functions"
NAME
fegetexceptflag, fesetexceptflag - get and set floating-point status flags
SYNOPSIS

cc [ flag... ] file... -lm [ library... ]
#include <fenv.h>

int fegetexceptflag(fexcept_t *flagp, int excepts);

int fesetexceptflag(const fexcept_t *flagp, int excepts);
DESCRIPTION

The fegetexceptflag() function attempts to store an implementation-defined representation of the states of the floating-point status flags indicated by the excepts argument in the object pointed to by the flagp argument.

The fesetexceptflag() function attempts to set the floating-point status flags indicated by the excepts argument to the states stored in the object pointed to by flagp. The value pointed to by flagp will have been set by a previous call to fegetexceptflag() whose second argument represented at least those floating-point exceptions represented by the excepts argument. This function does not raise floating-point exceptions but only sets the state of the flags.

RETURN VALUES

If the representation was successfully stored, fegetexceptflag() returns 0. Otherwise, it returns a non-zero value.

If the excepts argument is 0 or if all the specified exceptions were successfully set, fesetexceptflag() returns 0. Otherwise, it returns a non-zero value.

ERRORS

No errors are defined.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

fenv.h (3HEAD), feclearexcept (3M), feraiseexcept (3M), fesetexceptflag (3M), attributes (7), standards (7)