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

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

.. _omp_init_nest_lock:

omp_init_nest_lock -- Initialize nested lock
********************************************

Description:
  Initialize a nested lock.  After initialization, the lock is in
  an unlocked state and the nesting count is set to zero.

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

     * - *Prototype*:
       - ``void omp_init_nest_lock(omp_nest_lock_t *lock);``

Fortran:
  .. list-table::

     * - *Interface*:
       - ``subroutine omp_init_nest_lock(nvar)``
     * -
       - ``integer(omp_nest_lock_kind), intent(out) :: nvar``

See also:
  :ref:`omp_destroy_nest_lock`

Reference:
  :openmp:`4.5`, Section 3.3.1.
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_init_nest_lock:
	7
	8	omp_init_nest_lock -- Initialize nested lock
	9	********************************************
	10
	11	Description:
	12	Initialize a nested lock. After initialization, the lock is in
	13	an unlocked state and the nesting count is set to zero.
	14
	15	C/C++:
	16	.. list-table::
	17
	18	* - Prototype:
	19	- ``void omp_init_nest_lock(omp_nest_lock_t *lock);``
	20
	21	Fortran:
	22	.. list-table::
	23
	24	* - Interface:
	25	- ``subroutine omp_init_nest_lock(nvar)``
	26	* -
	27	- ``integer(omp_nest_lock_kind), intent(out) :: nvar``
	28
	29	See also:
	30	:ref:`omp_destroy_nest_lock`
	31
	32	Reference:
3ed1b4ce	33	:openmp:`4.5`, Section 3.3.1.