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$ 29.\" 30.Dd July 29, 1998 31.Dt PTHREAD_MUTEX_INIT 3 32.Os BSD 4 33.Sh NAME 34.Nm pthread_mutex_init 35.Nd create a mutex 36.Sh SYNOPSIS 37.Fd #include <pthread.h> 38.Ft int 39.Fn pthread_mutex_init "pthread_mutex_t *mutex" "const pthread_mutexattr_t *attr" 40.Sh DESCRIPTION 41The 42.Fn pthread_mutex_init 43function creates a new mutex, with attributes specified with 44.Fa attr . 45If 46.Fa attr 47is NULL the default attributes are used. 48.Sh RETURN VALUES 49If successful, 50.Fn pthread_mutex_init 51will return zero and put the new mutex id into 52.Fa mutex , 53otherwise an error number will be returned to indicate the error. 54.Sh ERRORS 55.Fn pthread_mutex_init 56will fail if: 57.Bl -tag -width Er 58.It Bq Er EINVAL 59The value specified by 60.Fa attr 61is invalid. 62.It Bq Er ENOMEM 63The process cannot allocate enough memory to create another mutex. 64.It Bq Er EAGAIN 65The temporarily lacks the resources to create another mutex. 66.El 67.Pp 68.Sh SEE ALSO 69.Xr pthread_mutex_destroy 3 , 70.Xr pthread_mutex_lock 3 , 71.Xr pthread_mutex_trylock 3 , 72.Xr pthread_mutex_unlock 3 73.Sh STANDARDS 74.Fn pthread_mutex_init 75conforms to ISO/IEC 9945-1 ANSI/IEEE 76.Pq Dq Tn POSIX 77Std 1003.1 Second Edition 1996-07-12. 78