lib/libc_r/man/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: src/lib/libc_r/man/pthread_rwlock_destroy.3,v 1.3.2.3 2001/12/17 10:08:26 ru Exp $
  26 .\" $DragonFly: src/lib/libc_r/man/pthread_rwlock_destroy.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  27 .\"
  28 .Dd August 4, 1998
  29 .Dt PTHREAD_RWLOCK_DESTROY 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_rwlock_destroy
  33 .Nd destroy a read/write lock
  34 .Sh LIBRARY
  35 .Lb libc_r
  36 .Sh SYNOPSIS
  37 .In pthread.h
  38 .Ft int
  39 .Fn pthread_rwlock_destroy "pthread_rwlock_t *lock"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pthread_rwlock_destroy
  43 function is used to destroy a read/write lock previously created with
  44 .Fn pthread_rwlock_init .
  45 .Sh RETURN VALUES
  46 If successful, the
  47 .Fn pthread_rwlock_destroy
  48 function will return zero.  Otherwise an error number will be returned
  49 to indicate the error.
  50 .Sh SEE ALSO
  51 .Xr pthread_rwlock_init 3
  52 .Sh STANDARDS
  53 The
  54 .Fn pthread_rwlock_destroy
  55 function is expected to conform to
  56 .St -susv2 .
  57 .Sh ERRORS
  58 The
  59 .Fn pthread_rwlock_destroy
  60 function will fail if:
  61 .Bl -tag -width Er
  62 .It Bq Er EPERM
  63 The caller does not have the privilege to perform the operation.
  64 .El
  65 .Pp
  66 The
  67 .Fn pthread_rwlock_destroy
  68 function may fail if:
  69 .Bl -tag -width Er
  70 .It Bq Er EBUSY
  71 The system has detected an attempt to destroy the object referenced by
  72 .Fa lock
  73 while it is locked.
  74 .It Bq Er EINVAL
  75 The value specified by
  76 .Fa lock
  77 is invalid.
  78 .El
  79 .Sh HISTORY
  80 The
  81 .Fn pthread_rwlock_destroy
  82 function first appeared in
  83 .Fx 3.0 .