xref: /freebsd/share/man/man3/pthread_mutexattr_getkind_np.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
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 October 12, 2021
26.Dt PTHREAD_MUTEXATTR_GETKIND_NP 3
27.Os
28.Sh NAME
29.Nm pthread_mutexattr_getkind_np ,
30.Nm pthread_mutexattr_setkind_np
31.Nd mutex attribute operations (legacy)
32.Sh LIBRARY
33.Lb libpthread
34.Sh SYNOPSIS
35.In pthread_np.h
36.Ft int
37.Fn pthread_mutexattr_getkind_np "pthread_mutexattr_t attr"
38.Ft int
39.Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind"
40.Sh DESCRIPTION
41.Bf -symbolic
42These functions are deprecated and non-portable implementation of
43the mutex type manipulation.
44.Ef
45.Pp
46It is recommended to use the
47.Xr pthread_mutexattr_gettype 3
48and
49.Xr pthread_mutexattr_settype 3
50functions instead.
51.Sh RETURN VALUES
52The
53.Fn pthread_mutexattr_getkind_np
54function returns a positive value representing the
55.Dq kind
56of the mutex attribute
57.Fa attr
58if successful; otherwise the value \-1 is returned and the global variable
59.Va errno
60is set to indicate the error.
61.Pp
62.Rv -std pthread_mutexattr_setkind_np
63.Sh ERRORS
64The
65.Fn pthread_mutexattr_getkind_np
66and
67.Fn pthread_mutexattr_setkind_np
68functions will fail if:
69.Bl -tag -width Er
70.It Bq Er EINVAL
71The value specified by
72.Fa attr
73is invalid.
74.El
75.Sh SEE ALSO
76.Xr pthread_mutex_destroy 3 ,
77.Xr pthread_mutex_init 3 ,
78.Xr pthread_mutexattr_gettype 3 ,
79.Xr pthread_mutexattr_settype 3 ,
80.Xr pthread_np 3
81