share/man/man3/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 LIBRARY
  34 .Lb libpthread
  35 .Sh SYNOPSIS
  36 .In pthread.h
  37 .Ft int
  38 .Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn pthread_rwlockattr_init
  42 function is used to initialize a read/write lock attributes object.
  43 .Sh RETURN VALUES
  44 If successful, the
  45 .Fn pthread_rwlockattr_init
  46 function will return zero.
  47 Otherwise an error number will be returned
  48 to indicate the error.
  49 .Sh ERRORS
  50 The
  51 .Fn pthread_rwlockattr_init
  52 function will fail if:
  53 .Bl -tag -width Er
  54 .It Bq Er ENOMEM
  55 Insufficient memory exists to initialize the attribute object.
  56 .El
  57 .Sh SEE ALSO
  58 .Xr pthread_rwlockattr_destroy 3 ,
  59 .Xr pthread_rwlockattr_getpshared 3 ,
  60 .Xr pthread_rwlockattr_setpshared 3 ,
  61 .Xr pthread_rwlock_init 3
  62 .Sh STANDARDS
  63 The
  64 .Fn pthread_rwlockattr_init
  65 function is expected to conform to
  66 .St -susv2 .
  67 .Sh HISTORY
  68 The
  69 .Fn pthread_rwlockattr_init
  70 function first appeared in
  71 .Fx 3.0 .