pthreads/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.6 2001/10/01 16:09:09 ru Exp $
  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 SYNOPSIS
  34 .In pthread.h
  35 .Ft int
  36 .Fo pthread_rwlock_destroy
  37 .Fa "pthread_rwlock_t *rwlock"
  38 .Fc
  39 .Sh DESCRIPTION
  40 The
  41 .Fn pthread_rwlock_destroy
  42 function is used to destroy a read/write lock previously created with
  43 .Fn pthread_rwlock_init .
  44 .Sh RETURN VALUES
  45 If successful, the
  46 .Fn pthread_rwlock_destroy
  47 function will return zero.
  48 Otherwise, an error number will be returned to indicate the error.
  49 .Sh SEE ALSO
  50 .Xr pthread_rwlock_init 3
  51 .Sh STANDARDS
  52 The
  53 .Fn pthread_rwlock_destroy
  54 function is expected to conform to
  55 .St -susv2 .
  56 .Sh ERRORS
  57 The
  58 .Fn pthread_rwlock_destroy
  59 function will fail if:
  60 .Bl -tag -width Er
  61 .It Bq Er EPERM
  62 The caller does not have the privilege to perform the operation.
  63 .El
  64 .Pp
  65 The
  66 .Fn pthread_rwlock_destroy
  67 function may fail if:
  68 .Bl -tag -width Er
  69 .It Bq Er EBUSY
  70 The system has detected an attempt to destroy the object referenced by
  71 .Fa rwlock
  72 while it is locked.
  73 .It Bq Er EINVAL
  74 The value specified by
  75 .Fa rwlock
  76 is invalid.
  77 .El
  78 .Sh HISTORY
  79 The
  80 .Fn pthread_rwlock_destroy
  81 function first appeared in
  82 .Fx 3.0 .