.. _mpi_abi_set_fortran_booleans:


MPI_Abi_set_fortran_booleans
============================

.. include_body

:ref:`MPI_Abi_set_fortran_booleans` |mdash| allows the application
to inform the implementation of the literal values of the Fortran booleans.

.. The following file was automatically generated
.. include:: ./bindings/mpi_abi_set_fortran_booleans.rst

INPUT PARAMETERS
----------------
* ``logical_size``: the size of Fortran logical in bytes
* ``logical_true``: the Fortran literal value TRUE
* ``logical_false``: the Fortran literal value FALSE

OUTPUT PARAMETERS
-----------------
* ``ierror``: Fortran only: Error status (integer).

DESCRIPTION
-----------

:ref:`MPI_Abi_set_fortran_booleans` allows the application to inform the implementation
of the literal values of the Fortran booleans.  Prior to setting this information, the application should
check if the logical values are already set using :ref:`MPI_Abi_get_fortran_booleans`.

*logical_size* is the size in bytes of a Fortran logical and must be a power of two;
otherwise ``MPI_ERR_ARG`` is returned.  This routine may be called at most once; a
subsequent call returns ``MPI_ERR_ABI``.

When Open MPI is built with Fortran logical support, the values returned
by :ref:`MPI_Abi_get_fortran_booleans` come from Open MPI's configured
Fortran support.  User-supplied values from
``MPI_Abi_set_fortran_booleans`` are used by
``MPI_Abi_get_fortran_booleans`` only when Open MPI is built without
Fortran logical support.

ERRORS
------

.. include:: ./ERRORS.rst

.. seealso::
   * :ref:`MPI_Abi_set_fortran_info`
   * :ref:`MPI_Abi_get_fortran_info`
   * :ref:`MPI_Abi_get_fortran_booleans`
