share/man/man3/pthread_rwlock_unlock.3

   1 .\" Copyright (c) 1998 Alex Nash
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd August 4, 1998
  28 .Dt PTHREAD_RWLOCK_UNLOCK 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_rwlock_unlock
  32 .Nd release a read/write lock
  33 .Sh LIBRARY
  34 .Lb libc_r
  35 .Lb libpthread
  36 .Lb libthr
  37 .Sh SYNOPSIS
  38 .In pthread.h
  39 .Ft int
  40 .Fn pthread_rwlock_unlock "pthread_rwlock_t *lock"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_rwlock_unlock
  44 function is used to release the read/write lock previously obtained by
  45 .Fn pthread_rwlock_rdlock ,
  46 .Fn pthread_rwlock_wrlock ,
  47 .Fn pthread_rwlock_tryrdlock ,
  48 or
  49 .Fn pthread_rwlock_trywrlock .
  50 .Sh RETURN VALUES
  51 If successful, the
  52 .Fn pthread_rwlock_unlock
  53 function will return zero.
  54 Otherwise an error number will be returned
  55 to indicate the error.
  56 .Pp
  57 The results are undefined if
  58 .Fa lock
  59 is not held by the calling thread.
  60 .Sh ERRORS
  61 The
  62 .Fn pthread_rwlock_unlock
  63 function may fail if:
  64 .Bl -tag -width Er
  65 .It Bq Er EINVAL
  66 The value specified by
  67 .Fa lock
  68 is invalid.
  69 .It Bq Er EPERM
  70 The current thread does not own the read/write lock.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr pthread_rwlock_rdlock 3 ,
  74 .Xr pthread_rwlock_wrlock 3
  75 .Sh STANDARDS
  76 The
  77 .Fn pthread_rwlock_unlock
  78 function is expected to conform to
  79 .St -susv2 .
  80 .Sh HISTORY
  81 The
  82 .Fn pthread_rwlock_unlock
  83 function first appeared in
  84 .Fx 3.0 .