Merge remote branch 'crater/vendor/MDOCML' into HEAD
[dragonfly.git] / lib / libpthread / pthread_mutex_init.3
1 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
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 .\" 3. Neither the name of the author nor the names of any co-contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/share/man/man3/pthread_mutex_init.3,v 1.18 2007/10/22 10:08:00 ru Exp $
29 .\" $DragonFly: src/lib/libc_r/man/pthread_mutex_init.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
30 .\"
31 .Dd July 10, 2009
32 .Dt PTHREAD_MUTEX_INIT 3
33 .Os
34 .Sh NAME
35 .Nm pthread_mutex_init
36 .Nd create a mutex
37 .Sh LIBRARY
38 .Lb libpthread
39 .Sh SYNOPSIS
40 .In pthread.h
41 .Ft int
42 .Fn pthread_mutex_init "pthread_mutex_t *mutex" "const pthread_mutexattr_t *attr"
43 .Sh DESCRIPTION
44 The
45 .Fn pthread_mutex_init
46 function creates a new mutex, with attributes specified with
47 .Fa attr .
48 If
49 .Fa attr
50 is NULL the default attributes are used.
51 .Sh RETURN VALUES
52 If successful,
53 .Fn pthread_mutex_init
54 will return zero and put the new mutex id into
55 .Fa mutex ,
56 otherwise an error number will be returned to indicate the error.
57 .Sh ERRORS
58 The
59 .Fn pthread_mutex_init
60 function will fail if:
61 .Bl -tag -width Er
62 .It Bq Er EINVAL
63 The value specified by
64 .Fa attr
65 is invalid.
66 .It Bq Er ENOMEM
67 The process cannot allocate enough memory to create another mutex.
68 .El
69 .Sh SEE ALSO
70 .Xr pthread_mutexattr 3 ,
71 .Xr pthread_mutex_destroy 3 ,
72 .Xr pthread_mutex_lock 3 ,
73 .Xr pthread_mutex_trylock 3 ,
74 .Xr pthread_mutex_unlock 3
75 .Sh STANDARDS
76 The
77 .Fn pthread_mutex_init
78 function conforms to
79 .St -p1003.1-96 .