tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

pr_unlock.rst (642B)

      1 PR_Unlock
      2 =========
      3 
      4 Releases a specified lock object. Releasing an unlocked lock results in
      5 an error.
      6 
      7 Attempting to release a lock that was locked by a different thread
      8 causes undefined behavior.
      9 
     10 
     11 Syntax
     12 ------
     13 
     14 .. code::
     15 
     16   #include <prlock.h>
     17 
     18   PRStatus PR_Unlock(PRLock *lock);
     19 
     20 
     21 Parameter
     22 ~~~~~~~~~
     23 
     24 :ref:`PR_Unlock` has one parameter:
     25 
     26 ``lock``
     27   A pointer to a lock object to be released.
     28 
     29 
     30 Returns
     31 ~~~~~~~
     32 
     33 The function returns one of the following values:
     34 
     35 -  If successful, ``PR_SUCCESS``.
     36 -  If unsuccessful (for example, if the caller does not own the lock),
     37   ``PR_FAILURE``.
     38 
     39 
     40 See Also
     41 --------
     42 
     43 -  `PR_Lock <PR_Lock>`__