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 33.Sh NAME 34.Nm pthread_mutex_init 35.Nd create a mutex 36.Sh LIBRARY 37.Lb libc_r 38.Lb libpthread 39.Lb libthr 40.Sh SYNOPSIS 41.In pthread.h 42.Ft int 43.Fn pthread_mutex_init "pthread_mutex_t *mutex" "const pthread_mutexattr_t *attr" 44.Sh DESCRIPTION 45The 46.Fn pthread_mutex_init 47function creates a new mutex, with attributes specified with 48.Fa attr . 49If 50.Fa attr 51is NULL the default attributes are used. 52.Sh RETURN VALUES 53If successful, 54.Fn pthread_mutex_init 55will return zero and put the new mutex id into 56.Fa mutex , 57otherwise an error number will be returned to indicate the error. 58.Sh ERRORS 59The 60.Fn pthread_mutex_init 61function will fail if: 62.Bl -tag -width Er 63.It Bq Er EINVAL 64The value specified by 65.Fa attr 66is invalid. 67.It Bq Er ENOMEM 68The process cannot allocate enough memory to create another mutex. 69.El 70.Sh SEE ALSO 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 76The 77.Fn pthread_mutex_init 78function conforms to 79.St -p1003.1-96 . 80