xref: /freebsd/share/man/man3/pthread_rwlockattr_destroy.3 (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
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_RWLOCKATTR_DESTROY 3
29.Os
30.Sh NAME
31.Nm pthread_rwlockattr_destroy
32.Nd destroy a read/write lock
33.Sh LIBRARY
34.Lb libc_r
35.Lb libpthread
36.Lb libthr
37.Sh SYNOPSIS
38.In pthread.h
39.Ft int
40.Fn pthread_rwlockattr_destroy "pthread_rwlockattr_t *attr"
41.Sh DESCRIPTION
42The
43.Fn pthread_rwlockattr_destroy
44function is used to destroy a read/write lock attribute object
45previously created with
46.Fn pthread_rwlockattr_init .
47.Sh RETURN VALUES
48If successful, the
49.Fn pthread_rwlockattr_destroy
50function will return zero.
51Otherwise an error number will be returned
52to indicate the error.
53.Sh SEE ALSO
54.Xr pthread_rwlockattr_init 3
55.Sh STANDARDS
56The
57.Fn pthread_rwlockattr_destroy
58function is expected to conform to
59.St -susv2 .
60.Sh ERRORS
61The
62.Fn pthread_rwlockattr_destroy
63function may fail if:
64.Bl -tag -width Er
65.It Bq Er EINVAL
66The value specified by
67.Fa attr
68is invalid.
69.El
70.Sh HISTORY
71The
72.Fn pthread_rwlockattr_destroy
73function first appeared in
74.Fx 3.0 .
75