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