share/man/man3/pthread_rwlock_destroy.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_DESTROY 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_rwlock_destroy
  32 .Nd destroy 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_destroy "pthread_rwlock_t *lock"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_rwlock_destroy
  44 function is used to destroy a read/write lock previously created with
  45 .Fn pthread_rwlock_init .
  46 .Sh RETURN VALUES
  47 If successful, the
  48 .Fn pthread_rwlock_destroy
  49 function will return zero.
  50 Otherwise an error number will be returned
  51 to indicate the error.
  52 .Sh ERRORS
  53 The
  54 .Fn pthread_rwlock_destroy
  55 function will fail if:
  56 .Bl -tag -width Er
  57 .It Bq Er EPERM
  58 The caller does not have the privilege to perform the operation.
  59 .El
  60 .Pp
  61 The
  62 .Fn pthread_rwlock_destroy
  63 function may fail if:
  64 .Bl -tag -width Er
  65 .It Bq Er EBUSY
  66 The system has detected an attempt to destroy the object referenced by
  67 .Fa lock
  68 while it is locked.
  69 .It Bq Er EINVAL
  70 The value specified by
  71 .Fa lock
  72 is invalid.
  73 .El
  74 .Sh SEE ALSO
  75 .Xr pthread_rwlock_init 3
  76 .Sh STANDARDS
  77 The
  78 .Fn pthread_rwlock_destroy
  79 function is expected to conform to
  80 .St -susv2 .
  81 .Sh HISTORY
  82 The
  83 .Fn pthread_rwlock_destroy
  84 function first appeared in
  85 .Fx 3.0 .