xref: /freebsd/share/man/man3/pthread_rwlock_destroy.3 (revision 7f3dea244c40159a41ab22da77a434d7c5b5e85a)
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$
26.\"
27.Dd August 4, 1998
28.Dt PTHREAD_RWLOCK_DESTROY 3
29.Os
30.Sh NAME
31.Nm pthread_rwlock_destroy
32.Nd destroy a read/write lock
33.Sh SYNOPSIS
34.Fd #include <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.  Otherwise an error number will be returned
46to indicate the error.
47.Sh SEE ALSO
48.Xr pthread_rwlock_init 3
49.Sh STANDARDS
50The
51.Fn pthread_rwlock_destroy
52function is expected to conform to
53.St -susv2 .
54.Sh ERRORS
55The
56.Fn pthread_rwlock_destroy
57function will fail if:
58.Bl -tag -width Er
59.It Bq Er EPERM
60The caller does not have the privilege to perform the operation.
61.El
62.Pp
63The
64.Fn pthread_rwlock_destroy
65function may fail if:
66.Bl -tag -width Er
67.It Bq Er EBUSY
68The system has detected an attempt to destroy the object referenced by
69.Fa lock
70while it is locked.
71.It Bq Er EINVAL
72The value specified by
73.Fa lock
74is invalid.
75.El
76.Sh HISTORY
77The
78.Fn pthread_rwlock_destroy
79function first appeared in
80.Fx 3.0 .
81