projects / apple / libpthread.git / blame
| Commit | Line | Data |
|---|---|---|
| f1a1da6c A |
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/lib/libc_r/man/pthread_mutex_init.3,v 1.6.2.4 2001/08/17 15:42:51 ru Exp $ | |
| 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 SYNOPSIS | |
| 37 | .Fd #include <pthread.h> | |
| 38 | .Ft int | |
| 39 | .Fo pthread_mutex_init | |
| 40 | .Fa "pthread_mutex_t *restrict mutex" | |
| 41 | .Fa "const pthread_mutexattr_t *restrict attr" | |
| 42 | .Fc | |
| 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 | .Fn pthread_mutex_init | |
| 59 | will fail if: | |
| 60 | .Bl -tag -width Er | |
| 61 | .It Bq Er EAGAIN | |
| 62 | The system temporarily lacks the resources to create another mutex. | |
| 63 | .It Bq Er EINVAL | |
| 64 | The value specified by | |
| 65 | .Fa attr | |
| 66 | is invalid. | |
| 67 | .It Bq Er ENOMEM | |
| 68 | The 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 | |
| 76 | .Fn pthread_mutex_init | |
| 77 | conforms to | |
| 78 | .St -p1003.1-96 . |