feholdexcept

- save current floating-point environment

Synopsis

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

int feholdexcept(fenv_t *envp);

Description

The feholdexcept() function saves the current floating-point environment in the object pointed to by envp, clears the floating-point status flags, and then installs a non-stop (continue on floating-point exceptions) mode, if available, for all floating-point exceptions.

Return Values

The feholdexcept() function returns 0 if and only if non-stop floating-point exception handling was successfully installed.

Errors

No errors are defined.

Attributes

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

See Also

fegetenv(3M), fenv.h(3HEAD), feupdateenv(3M), attributes(5), standards(5)

Notes

In a multithreaded program, the feholdexcept() function affects the floating point environment only for the calling thread.

The feholdexcept() function automatically installs and deinstalls SIGFPE handlers and sets and clears the trap enable mode bits in the floating point status register as needed. If a program uses these functions and attempts to install a SIGFPE handler or control the trap enable mode bits independently, the resulting behavior is not defined.