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