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