lib/libpthread/man/pthread_rwlockattr_init.3

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