..
   This file is part of Logtalk <https://logtalk.org/>
   SPDX-FileCopyrightText: 1998-2025 Paulo Moura <pmoura@logtalk.org>
   SPDX-License-Identifier: Apache-2.0

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.


.. rst-class:: align-right

**built-in predicate**

.. index:: pair: current_logtalk_flag/2; Built-in predicate
.. _predicates_current_logtalk_flag_2:

``current_logtalk_flag/2``
==========================

Description
-----------

::

   current_logtalk_flag(Flag, Value)

Enumerates, by backtracking, the current Logtalk flag values. For
a description of the predefined compiler flags, please see the
:ref:`programming_flags` section in the User Manual.

Modes and number of proofs
--------------------------

::

   current_logtalk_flag(?atom, ?atom) - zero_or_more

Errors
------

| ``Flag`` is neither a variable nor an atom:
|     ``type_error(atom, Flag)``
| ``Flag`` is an atom but an invalid flag:
|     ``domain_error(flag, Value)``

Examples
--------

::

   % get the current value of the source_data flag:
   | ?- current_logtalk_flag(source_data, Value).

.. seealso::

   :ref:`predicates_create_logtalk_flag_3`,
   :ref:`predicates_set_logtalk_flag_2`
