git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	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_unlock.3,v 1.5.2.4 2001/08/17 15:42:51 ru Exp $
	29	.\"
	30	.Dd July 30, 1998
	31	.Dt PTHREAD_MUTEX_UNLOCK 3
	32	.Os
	33	.Sh NAME
	34	.Nm pthread_mutex_unlock
	35	.Nd unlock a mutex
	36	.Sh SYNOPSIS
	37	.Fd #include <pthread.h>
	38	.Ft int
	39	.Fo pthread_mutex_unlock
	40	.Fa "pthread_mutex_t *mutex"
	41	.Fc
	42	.Sh DESCRIPTION
	43	If the current thread holds the lock on
	44	.Fa mutex ,
	45	then the
	46	.Fn pthread_mutex_unlock
	47	function unlocks
	48	.Fa mutex .
	49	.Pp
	50	Calling
	51	.Fn pthread_mutex_unlock
	52	with a
	53	.Fa mutex
	54	that the calling thread does not hold will result
	55	in undefined behavior.
	56	.Sh RETURN VALUES
	57	If successful,
	58	.Fn pthread_mutex_unlock
	59	will return zero.
	60	Otherwise, an error number will be returned to indicate the error.
	61	.Sh ERRORS
	62	.Fn pthread_mutex_unlock
	63	will fail if:
	64	.Bl -tag -width Er
	65	.It Bq Er EINVAL
	66	The value specified by
	67	.Fa mutex
	68	is invalid.
	69	.It Bq Er EPERM
	70	The current thread does not hold a lock on
	71	.Fa mutex .
	72	.El
	73	.Sh SEE ALSO
	74	.Xr pthread_mutex_destroy 3 ,
	75	.Xr pthread_mutex_init 3 ,
	76	.Xr pthread_mutex_lock 3 ,
	77	.Xr pthread_mutex_trylock 3
	78	.Sh STANDARDS
	79	.Fn pthread_mutex_unlock
	80	conforms to
	81	.St -p1003.1-96 .