xref: /freebsd/share/man/man3/pthread_rwlock_destroy.3 (revision ec7452f103d56cccf279cec74a22025f980bbda5)
1c0e36632SAlexander Langer.\" Copyright (c) 1998 Alex Nash
2c0e36632SAlexander Langer.\" All rights reserved.
3c0e36632SAlexander Langer.\"
4c0e36632SAlexander Langer.\" Redistribution and use in source and binary forms, with or without
5c0e36632SAlexander Langer.\" modification, are permitted provided that the following conditions
6c0e36632SAlexander Langer.\" are met:
7c0e36632SAlexander Langer.\" 1. Redistributions of source code must retain the above copyright
8c0e36632SAlexander Langer.\"    notice, this list of conditions and the following disclaimer.
9c0e36632SAlexander Langer.\" 2. Redistributions in binary form must reproduce the above copyright
10c0e36632SAlexander Langer.\"    notice, this list of conditions and the following disclaimer in the
11c0e36632SAlexander Langer.\"    documentation and/or other materials provided with the distribution.
12c0e36632SAlexander Langer.\"
13c0e36632SAlexander Langer.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14c0e36632SAlexander Langer.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15c0e36632SAlexander Langer.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16c0e36632SAlexander Langer.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17c0e36632SAlexander Langer.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18c0e36632SAlexander Langer.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19c0e36632SAlexander Langer.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20c0e36632SAlexander Langer.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21c0e36632SAlexander Langer.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22c0e36632SAlexander Langer.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23c0e36632SAlexander Langer.\" SUCH DAMAGE.
24c0e36632SAlexander Langer.\"
257f3dea24SPeter Wemm.\" $FreeBSD$
26c0e36632SAlexander Langer.\"
27c0e36632SAlexander Langer.Dd August 4, 1998
28c0e36632SAlexander Langer.Dt PTHREAD_RWLOCK_DESTROY 3
29c0e36632SAlexander Langer.Os
30c0e36632SAlexander Langer.Sh NAME
31c0e36632SAlexander Langer.Nm pthread_rwlock_destroy
32c0e36632SAlexander Langer.Nd destroy a read/write lock
33d8a78688SAlexey Zelkin.Sh LIBRARY
34d8a78688SAlexey Zelkin.Lb libc_r
35ec7452f1SRuslan Ermilov.Lb libpthread
36c0e36632SAlexander Langer.Sh SYNOPSIS
3732eef9aeSRuslan Ermilov.In pthread.h
38c0e36632SAlexander Langer.Ft int
39c0e36632SAlexander Langer.Fn pthread_rwlock_destroy "pthread_rwlock_t *lock"
40c0e36632SAlexander Langer.Sh DESCRIPTION
41c0e36632SAlexander LangerThe
42c0e36632SAlexander Langer.Fn pthread_rwlock_destroy
43c0e36632SAlexander Langerfunction is used to destroy a read/write lock previously created with
44c0e36632SAlexander Langer.Fn pthread_rwlock_init .
45c0e36632SAlexander Langer.Sh RETURN VALUES
46c0e36632SAlexander LangerIf successful, the
47c0e36632SAlexander Langer.Fn pthread_rwlock_destroy
48c0e36632SAlexander Langerfunction will return zero.  Otherwise an error number will be returned
49c0e36632SAlexander Langerto indicate the error.
50c0e36632SAlexander Langer.Sh SEE ALSO
51b2e3e438SAlexander Langer.Xr pthread_rwlock_init 3
52c0e36632SAlexander Langer.Sh STANDARDS
53c0e36632SAlexander LangerThe
54c0e36632SAlexander Langer.Fn pthread_rwlock_destroy
55c0e36632SAlexander Langerfunction is expected to conform to
56c0e36632SAlexander Langer.St -susv2 .
57c0e36632SAlexander Langer.Sh ERRORS
58c0e36632SAlexander LangerThe
59c0e36632SAlexander Langer.Fn pthread_rwlock_destroy
60c0e36632SAlexander Langerfunction will fail if:
61c0e36632SAlexander Langer.Bl -tag -width Er
62c0e36632SAlexander Langer.It Bq Er EPERM
63c0e36632SAlexander LangerThe caller does not have the privilege to perform the operation.
64c0e36632SAlexander Langer.El
65c0e36632SAlexander Langer.Pp
66c0e36632SAlexander LangerThe
67c0e36632SAlexander Langer.Fn pthread_rwlock_destroy
68c0e36632SAlexander Langerfunction may fail if:
69c0e36632SAlexander Langer.Bl -tag -width Er
70c0e36632SAlexander Langer.It Bq Er EBUSY
71c0e36632SAlexander LangerThe system has detected an attempt to destroy the object referenced by
72c0e36632SAlexander Langer.Fa lock
73c0e36632SAlexander Langerwhile it is locked.
74c0e36632SAlexander Langer.It Bq Er EINVAL
75c0e36632SAlexander LangerThe value specified by
76c0e36632SAlexander Langer.Fa lock
77c0e36632SAlexander Langeris invalid.
78c0e36632SAlexander Langer.El
79c0e36632SAlexander Langer.Sh HISTORY
80c0e36632SAlexander LangerThe
81c0e36632SAlexander Langer.Fn pthread_rwlock_destroy
82c0e36632SAlexander Langerfunction first appeared in
83c0e36632SAlexander Langer.Fx 3.0 .
84