feholdexcept()

Updated: April 19, 2023

Save the floating-point environment, clear all flags, and ignore future errors

Synopsis:

#include <fenv.h>

int feholdexcept( fenv_t *envp );

Arguments:

envp
A pointer to a fenv_t object where the function can store the environment.

Library:

libm
The general-purpose math library.
libm-sve
(QNX Neutrino 7.1 or later) A library that optimizes the code for ARMv8.2 chips that have Scalable Vector Extension hardware.

Your system requirements will determine how you should work with these libraries:

Note: Compile your program with the -fno-builtin option to prevent the compiler from using a built-in version of the function.

Description:

The feholdexcept() function saves the floating-point environment in the object that envp points to, clears all the floating-point status flags, and installs a nonstop mode. In nonstop mode, floating-point exceptions don't interrupt execution.

CAUTION:
This operation doesn't work on AArch64 targets. There's a known hardware limitation that causes any saving of floating-point environments to be ignored.

To restore the floating-point environment, use fesetenv() or feupdateenv().

Returns:

0

Classification:

C99, POSIX 1003.1

Safety:  
Cancellation point No
Interrupt handler Yes
Signal handler Yes
Thread Yes