/share/man/man3/pthread_rwlock_destroy.3

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