feholdexcept - Man Page

save current floating-point environment

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

Synopsis

#include <fenv.h>

int feholdexcept(fenv_t *envp);

Description

The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2017 defers to the ISO C standard.

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

Return Value

The feholdexcept() function shall return zero if and only if non-stop floating-point exception handling was successfully installed.

Errors

No errors are defined.

The following sections are informative.

Examples

None.

Application Usage

None.

Rationale

The feholdexcept() function should be effective on typical IEC 60559:1989 standard implementations which have the default non-stop mode and at least one other mode for trap handling or aborting. If the implementation provides only the non-stop mode, then installing the non-stop mode is trivial.

Future Directions

None.

See Also

fegetenv(), feupdateenv()

The Base Definitions volume of POSIX.1-2017, <fenv.h>

Referenced By

fegetenv(3p), fenv.h(0p), feupdateenv(3p).

2017 IEEE/The Open Group POSIX Programmer's Manual