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