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