xref: /openbsd-src/lib/libpthread/man/pthread_rwlockattr_destroy.3 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\" $OpenBSD: pthread_rwlockattr_destroy.3,v 1.6 2000/04/12 21:48:02 aaron Exp $
2.\" Copyright (c) 1998 Alex Nash
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD: pthread_rwlockattr_destroy.3,v 1.3 1999/08/28 00:03:10 peter Exp $
27.\"
28.Dd August 4, 1998
29.Dt PTHREAD_RWLOCKATTR_DESTROY 3
30.Os
31.Sh NAME
32.Nm pthread_rwlockattr_destroy
33.Nd destroy a read/write lock
34.Sh SYNOPSIS
35.Fd #include <pthread.h>
36.Ft int
37.Fn pthread_rwlockattr_destroy "pthread_rwlockattr_t *attr"
38.Sh DESCRIPTION
39The
40.Fn pthread_rwlockattr_destroy
41function is used to destroy a read/write lock attribute object
42previously created with
43.Fn pthread_rwlockattr_init .
44.Sh RETURN VALUES
45If successful, the
46.Fn pthread_rwlockattr_destroy
47function will return zero.  Otherwise an error number will be returned
48to indicate the error.
49.Sh SEE ALSO
50.Xr pthread_rwlockattr_init 3
51.Sh STANDARDS
52The
53.Fn pthread_rwlockattr_destroy
54function is expected to conform to
55.St -susv2 .
56.Sh ERRORS
57.Fn pthread_rwlockattr_destroy
58may fail if:
59.Bl -tag -width Er
60.It Bq Er EINVAL
61The value specified by
62.Fa attr
63is invalid.
64.El
65.Sh HISTORY
66The
67.Fn pthread_rwlockattr_destroy
68function first appeared in
69.Fx 3.0
70and
71.Ox 2.5 .
72