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