xref: /openbsd-src/lib/libpthread/man/pthread_rwlock_destroy.3 (revision 5c3dced36cf8ba5814dbe5ef397db72526a1fd4f)
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.\"	$Id: pthread_rwlock_destroy.3,v 1.4 1999/07/09 13:35:25 aaron Exp $
26.\"	$OpenBSD: pthread_rwlock_destroy.3,v 1.4 1999/07/09 13:35:25 aaron Exp $
27.\"
28.Dd August 4, 1998
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.Fd #include <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.  Otherwise an error number will be returned
47to indicate the error.
48.Sh SEE ALSO
49.Xr pthread_rwlock_init 3
50.Sh STANDARDS
51The
52.Fn pthread_rwlock_destroy
53function is expected to conform to
54.St -susv2 .
55.Sh ERRORS
56The
57.Fn pthread_rwlock_destroy
58function will fail if:
59.Bl -tag -width Er
60.It Bq Er EPERM
61The caller does not have the privilege to perform the operation.
62.El
63.Pp
64The
65.Fn pthread_rwlock_destroy
66function may fail if:
67.Bl -tag -width Er
68.It Bq Er EBUSY
69The system has detected an attempt to destroy the object referenced by
70.Fa lock
71while it is locked.
72.It Bq Er EINVAL
73The value specified by
74.Fa lock
75is invalid.
76.El
77.Sh HISTORY
78The
79.Fn pthread_rwlock_destroy
80function first appeared in
81.Ox 2.5 .
82