lib/libpthread/pthread_rwlock_destroy.3

   1 .\" $NetBSD: pthread_rwlock_destroy.3,v 1.5 2005/06/17 18:26:53 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" Copyright (c) 1998 Alex Nash
  26 .\" All rights reserved.
  27 .\"
  28 .\" Redistribution and use in source and binary forms, with or without
  29 .\" modification, are permitted provided that the following conditions
  30 .\" are met:
  31 .\" 1. Redistributions of source code must retain the above copyright
  32 .\"    notice, this list of conditions and the following disclaimer.
  33 .\" 2. Redistributions in binary form must reproduce the above copyright
  34 .\"    notice, this list of conditions and the following disclaimer in the
  35 .\"    documentation and/or other materials provided with the distribution.
  36 .\"
  37 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  38 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  39 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  40 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  41 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  42 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  43 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  44 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  45 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  46 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  47 .\" SUCH DAMAGE.
  48 .\"
  49 .\" $FreeBSD: src/lib/libpthread/man/pthread_rwlock_destroy.3,v 1.7 2002/09/16 19:29:29 mini Exp $
  50 .\"
  51 .Dd January 30, 2003
  52 .Dt PTHREAD_RWLOCK_DESTROY 3
  53 .Os
  54 .Sh NAME
  55 .Nm pthread_rwlock_destroy
  56 .Nd destroy a read/write lock
  57 .Sh LIBRARY
  58 .Lb libpthread
  59 .Sh SYNOPSIS
  60 .In pthread.h
  61 .Ft int
  62 .Fn pthread_rwlock_destroy "pthread_rwlock_t *lock"
  63 .Sh DESCRIPTION
  64 The
  65 .Fn pthread_rwlock_destroy
  66 function is used to destroy a read/write lock previously created with
  67 .Fn pthread_rwlock_init .
  68 .Sh RETURN VALUES
  69 If successful, the
  70 .Fn pthread_rwlock_destroy
  71 function will return zero.
  72 Otherwise an error number will be returned to indicate the error.
  73 .Sh ERRORS
  74 The
  75 .Fn pthread_rwlock_destroy
  76 function may fail if:
  77 .Bl -tag -width Er
  78 .It Bq Er EBUSY
  79 The system has detected an attempt to destroy the object referenced by
  80 .Fa lock
  81 while it is locked.
  82 .It Bq Er EINVAL
  83 The value specified by
  84 .Fa lock
  85 is invalid.
  86 .El
  87 .Sh SEE ALSO
  88 .Xr pthread_rwlock_init 3 ,
  89 .Xr pthread_rwlock_rdlock 3 ,
  90 .Xr pthread_rwlock_unlock 3 ,
  91 .Xr pthread_rwlock_wrlock 3
  92 .Sh STANDARDS
  93 .Fn pthread_rwlock_destroy
  94 conforms to
  95 .St -p1003.1-96 .