pthreads/pthread_rwlockattr_getpshared.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: src/lib/libc_r/man/pthread_rwlockattr_getpshared.3,v 1.8 2001/10/01 16:09:09 ru Exp $
  26 .\"
  27 .Dd March 22, 1999
  28 .Dt PTHREAD_RWLOCKATTR_GETPSHARED 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_rwlockattr_getpshared
  32 .Nd get the process shared attribute
  33 .Sh SYNOPSIS
  34 .In pthread.h
  35 .Ft int
  36 .Fn pthread_rwlockattr_getpshared "const pthread_rwlockattr_t *attr" "int *pshared"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn pthread_rwlockattr_getpshared
  40 function is used to get the process shared setting of a read/write
  41 lock attribute object.  The setting is returned via
  42 .Fa pshared ,
  43 and may be one of two values:
  44 .Bl -tag -width PTHREAD_PROCESS_PRIVATE
  45 .It Dv PTHREAD_PROCESS_SHARED
  46 Any thread of any process that has access to the memory where the
  47 read/write lock resides can manipulate the lock.
  48 .It Dv PTHREAD_PROCESS_PRIVATE
  49 Only threads created within the same process as the thread that
  50 initialized the read/write lock can manipulate the lock.  This is
  51 the default value.
  52 .El
  53 .Sh RETURN VALUES
  54 If successful, the
  55 .Fn pthread_rwlockattr_getpshared
  56 function will return zero.  Otherwise an error number will be returned
  57 to indicate the error.
  58 .Sh SEE ALSO
  59 .Xr pthread_rwlockattr_init 3 ,
  60 .Xr pthread_rwlockattr_setpshared 3 ,
  61 .Xr pthread_rwlock_init 3
  62 .Sh STANDARDS
  63 The
  64 .Fn pthread_rwlockattr_getpshared
  65 function is expected to conform to
  66 .St -susv2 .
  67 .Sh ERRORS
  68 .Fn pthread_rwlockattr_getpshared
  69 may fail if:
  70 .Bl -tag -width Er
  71 .It Bq Er EINVAL
  72 The value specified by
  73 .Fa attr
  74 is invalid.
  75 .El
  76 .Sh HISTORY
  77 The
  78 .Fn pthread_rwlockattr_getpshared
  79 function first appeared in
  80 .Fx 3.0 .