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

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

.. _omp_set_max_active_levels:

omp_set_max_active_levels -- Limits the number of active parallel regions
*************************************************************************

Description:
  This function limits the maximum allowed number of nested, active
  parallel regions.  :samp:`{max_levels}` must be less or equal to
  the value returned by ``omp_get_supported_active_levels``.

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

     * - *Prototype*:
       - ``void omp_set_max_active_levels(int max_levels);``

Fortran:
  .. list-table::

     * - *Interface*:
       - ``subroutine omp_set_max_active_levels(max_levels)``
     * -
       - ``integer max_levels``

See also:
  :ref:`omp_get_max_active_levels`, :ref:`omp_get_active_level`,
  :ref:`omp_get_supported_active_levels`

Reference:
  :openmp:`4.5`, Section 3.2.15.
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_set_max_active_levels:
	7
	8	omp_set_max_active_levels -- Limits the number of active parallel regions
	9	*************************************************************************
	10
	11	Description:
	12	This function limits the maximum allowed number of nested, active
	13	parallel regions. :samp:`{max_levels}` must be less or equal to
	14	the value returned by ``omp_get_supported_active_levels``.
	15
	16	C/C++:
	17	.. list-table::
	18
	19	* - Prototype:
	20	- ``void omp_set_max_active_levels(int max_levels);``
	21
	22	Fortran:
	23	.. list-table::
	24
	25	* - Interface:
	26	- ``subroutine omp_set_max_active_levels(max_levels)``
	27	* -
	28	- ``integer max_levels``
	29
	30	See also:
	31	:ref:`omp_get_max_active_levels`, :ref:`omp_get_active_level`,
	32	:ref:`omp_get_supported_active_levels`
	33
	34	Reference:
3ed1b4ce	35	:openmp:`4.5`, Section 3.2.15.