xref: /illumos-gate/usr/src/man/man3m/feraiseexcept.3m (revision d042c5a26452797afc4fe8c2ceddebff94d88745)
te
Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
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 Sun OS 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]
FERAISEEXCEPT 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
NAME
feraiseexcept - raise floating-point exception
SYNOPSIS

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

int feraiseexcept(int excepts);
DESCRIPTION

The feraiseexcept() function attempts to raise the supported floating-point exceptions represented by the excepts argument. The order in which these floating-point exceptions are raised is unspecified.

RETURN VALUES

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

ERRORS

No errors are defined.

USAGE

The effect is intended to be similar to that of floating-point exceptions raised by arithmetic operations. Hence, enabled traps for floating-point exceptions raised by this function are taken.

ATTRIBUTES

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

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

feclearexcept(3M), fegetexceptflag(3M), fenv.h(3HEAD), fetestexcept(3M), attributes(5), standards(5)