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