man/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$
  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.
  42 The setting is returned via
  43 .Fa pshared ,
  44 and may be one of two values:
  45 .Bl -tag -width PTHREAD_PROCESS_PRIVATE
  46 .It Dv PTHREAD_PROCESS_SHARED
  47 Any thread of any process that has access to the memory where the
  48 read/write lock resides can manipulate the lock.
  49 .It Dv PTHREAD_PROCESS_PRIVATE
  50 Only threads created within the same process as the thread that
  51 initialized the read/write lock can manipulate the lock.
  52 This is
  53 the default value.
  54 .El
  55 .Sh RETURN VALUES
  56 If successful, the
  57 .Fn pthread_rwlockattr_getpshared
  58 function will return zero.
  59 Otherwise an error number will be returned
  60 to indicate the error.
  61 .Sh ERRORS
  62 The
  63 .Fn pthread_rwlockattr_getpshared
  64 function may fail if:
  65 .Bl -tag -width Er
  66 .It Bq Er EINVAL
  67 The value specified by
  68 .Fa attr
  69 is invalid.
  70 .El
  71 .Sh SEE ALSO
  72 .Xr pthread_rwlock_init 3 ,
  73 .Xr pthread_rwlockattr_init 3 ,
  74 .Xr pthread_rwlockattr_setpshared 3
  75 .Sh STANDARDS
  76 The
  77 .Fn pthread_rwlockattr_getpshared
  78 function is expected to conform to
  79 .St -susv2 .
  80 .Sh HISTORY
  81 The
  82 .Fn pthread_rwlockattr_getpshared
  83 function first appeared in
  84 .Fx 3.0 .