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