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