/share/man/man3/pthread_mutexattr_getkind_np.3

 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 libpthread
36.Sh SYNOPSIS
37.In pthread_np.h
38.Ft int
39.Fn pthread_mutexattr_getkind_np "pthread_mutexattr_t attr"
40.Ft int
41.Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind"
42.Sh DESCRIPTION
43.Bf -symbolic
44These functions are deprecated and non-portable implementation of
45the mutex type manipulation.
46.Ef
47.Pp
48It is recommended to use the
49.Xr pthread_mutexattr_gettype 3
50and
51.Xr pthread_mutexattr_settype 3
52functions instead.
53.Sh RETURN VALUES
54The
55.Fn pthread_mutexattr_getkind_np
56function returns a positive value representing the
57.Dq kind
58of the mutex attribute
59.Fa attr
60if successful; otherwise the value \-1 is returned and the global variable
61.Va errno
62is set to indicate the error.
63.Pp
64.Rv -std pthread_mutexattr_setkind_np
65.Sh ERRORS
66The
67.Fn pthread_mutexattr_getkind_np
68and
69.Fn pthread_mutexattr_setkind_np
70functions will fail if:
71.Bl -tag -width Er
72.It Bq Er EINVAL
73The value specified by
74.Fa attr
75is invalid.
76.El
77.Sh SEE ALSO
78.Xr pthread_mutexattr_gettype 3 ,
79.Xr pthread_mutexattr_settype 3 ,
80.Xr pthread_mutex_destroy 3 ,
81.Xr pthread_mutex_init 3