1.\" $OpenBSD: pthread_mutex_init.3,v 1.6 1999/11/24 05:35:32 d Exp $ 2.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. Neither the name of the author nor the names of any co-contributors 14.\" may be used to endorse or promote products derived from this software 15.\" without specific prior written permission. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" 29.\" $FreeBSD: pthread_mutex_init.3,v 1.6 1999/08/28 00:03:07 peter Exp $ 30.\" 31.Dd July 29, 1998 32.Dt PTHREAD_MUTEX_INIT 3 33.Os 34.Sh NAME 35.Nm pthread_mutex_init 36.Nd create a mutex 37.Sh SYNOPSIS 38.Fd #include <pthread.h> 39.Ft int 40.Fn pthread_mutex_init "pthread_mutex_t *mutex" "const pthread_mutexattr_t *attr" 41.Sh DESCRIPTION 42The 43.Fn pthread_mutex_init 44function creates a new mutex, with attributes specified with 45.Fa attr . 46If 47.Fa attr 48is 49.Dv NULL 50the default attributes are used. 51.Sh RETURN VALUES 52If successful, 53.Fn pthread_mutex_init 54will return zero and put the new mutex ID into 55.Fa mutex , 56otherwise an error number will be returned to indicate the error. 57.Sh ERRORS 58.Fn pthread_mutex_init 59will fail if: 60.Bl -tag -width Er 61.It Bq Er EINVAL 62The value specified by 63.Fa attr 64is invalid. 65.It Bq Er ENOMEM 66The process cannot allocate enough memory to create another mutex. 67.It Bq Er EAGAIN 68The temporarily lacks the resources 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 76.Fn pthread_mutex_init 77conforms to ISO/IEC 9945-1 ANSI/IEEE 78.Pq Dq Tn POSIX 79Std 1003.1 Second Edition 1996-07-12. 80