1.\" $OpenBSD: pthread_rwlock_destroy.3,v 1.9 2013/06/05 03:44:50 tedu Exp $
2.\" Copyright (c) 1998 Alex Nash
3.\" All rights reserved.
4.\"
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.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD: pthread_rwlock_destroy.3,v 1.3 1999/08/28 00:03:09 peter Exp $
27.\"
28.Dd $Mdocdate: June 5 2013 $
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 SYNOPSIS
35.In pthread.h
36.Ft int
37.Fn pthread_rwlock_destroy "pthread_rwlock_t *lock"
38.Sh DESCRIPTION
39The
40.Fn pthread_rwlock_destroy
41function is used to destroy a read/write lock previously created with
42.Fn pthread_rwlock_init .
43.Sh RETURN VALUES
44If successful, the
45.Fn pthread_rwlock_destroy
46function will return zero.
47Otherwise an error number will be returned to 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
82and
83.Ox 2.5 .
84