1.\" $OpenBSD: pthread_rwlockattr_init.3,v 1.5 2000/04/12 21:48:03 aaron Exp $ 2.\" Copyright (c) 1998 Alex Nash 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.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD: pthread_rwlockattr_init.3,v 1.3 1999/08/28 00:03:10 peter Exp $ 27.\" 28.Dd August 4, 1998 29.Dt PTHREAD_RWLOCKATTR_INIT 3 30.Os 31.Sh NAME 32.Nm pthread_rwlockattr_init 33.Nd initialize a read/write lock 34.Sh SYNOPSIS 35.Fd #include <pthread.h> 36.Ft int 37.Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr" 38.Sh DESCRIPTION 39The 40.Fn pthread_rwlockattr_init 41function is used to initialize a read/write lock attributes object. 42.Sh RETURN VALUES 43If successful, the 44.Fn pthread_rwlockattr_init 45function will return zero. Otherwise an error number will be returned 46to indicate the error. 47.Sh SEE ALSO 48.Xr pthread_rwlock_init 3 , 49.Xr pthread_rwlockattr_destroy 3 , 50.Xr pthread_rwlockattr_getpshared 3 , 51.Xr pthread_rwlockattr_setpshared 3 52.Sh STANDARDS 53The 54.Fn pthread_rwlockattr_init 55function is expected to conform to 56.St -susv2 . 57.Sh ERRORS 58.Fn pthread_rwlockattr_init 59will fail if: 60.Bl -tag -width Er 61.It Bq Er ENOMEM 62Insufficient memory exists to initialize the attribute object. 63.El 64.Sh HISTORY 65The 66.Fn pthread_rwlockattr_init 67function first appeared in 68.Fx 3.0 69and 70.Ox 2.5 . 71