..
   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 method**

.. index:: pair: fail/0; Built-in method
.. _methods_fail_0:

``fail/0``
==========

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

::

   fail

Always fails. See also the ISO Prolog standard definition. This built-in
method is declared as a public method and can be used as a message to an
object.

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

::

   fail - one

Errors
------

(none)

Examples
--------

(none)

.. seealso::

   :ref:`methods_cut_0`,
   :ref:`methods_true_0`,
   :ref:`methods_false_0`,
   :ref:`methods_repeat_0`
