[thirdparty/gcc.git] / libgomp / doc / openmp-runtime-library-routines / ompgetcancellation.rst

..
  Copyright 1988-2022 Free Software Foundation, Inc.
  This is part of the GCC manual.
  For copying conditions, see the copyright.rst file.

.. _omp_get_cancellation:

omp_get_cancellation -- Whether cancellation support is enabled
***************************************************************

Description:
  This function returns ``true`` if cancellation is activated, ``false``
  otherwise.  Here, ``true`` and ``false`` represent their language-specific
  counterparts.  Unless :envvar:`OMP_CANCELLATION` is set true, cancellations are
  deactivated.

C/C++:
  .. list-table::

     * - *Prototype*:
       - ``int omp_get_cancellation(void);``

Fortran:
  .. list-table::

     * - *Interface*:
       - ``logical function omp_get_cancellation()``

See also:
  :ref:`OMP_CANCELLATION`

Reference:
  :openmp:`4.5`, Section 3.2.9.
Commit	Line	Data
c63539ff ML	1	..
	2	Copyright 1988-2022 Free Software Foundation, Inc.
	3	This is part of the GCC manual.
	4	For copying conditions, see the copyright.rst file.
	5
	6	.. _omp_get_cancellation:
	7
	8	omp_get_cancellation -- Whether cancellation support is enabled
	9	***************************************************************
	10
	11	Description:
	12	This function returns ``true`` if cancellation is activated, ``false``
	13	otherwise. Here, ``true`` and ``false`` represent their language-specific
	14	counterparts. Unless :envvar:`OMP_CANCELLATION` is set true, cancellations are
	15	deactivated.
	16
	17	C/C++:
	18	.. list-table::
	19
	20	* - Prototype:
	21	- ``int omp_get_cancellation(void);``
	22
	23	Fortran:
	24	.. list-table::
	25
	26	* - Interface:
	27	- ``logical function omp_get_cancellation()``
	28
	29	See also:
	30	:ref:`OMP_CANCELLATION`
	31
	32	Reference:
3ed1b4ce	33	:openmp:`4.5`, Section 3.2.9.