| | 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 | .Fo pthread_rwlockattr_getpshared |
| | 37 | .Fa "const pthread_rwlockattr_t *restrict attr" |
| | 38 | .Fa "int *restrict pshared" |
| | 39 | .Fc |
| | 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. The setting is returned via |
| | 45 | .Fa pshared , |
| | 46 | and 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. This is |
| | 54 | the default value. |
| | 55 | .El |
| | 56 | .Sh RETURN VALUES |
| | 57 | If successful, the |
| | 58 | .Fn pthread_rwlockattr_getpshared |
| | 59 | function will return zero. |
| | 60 | Otherwise, an error number will be returned to indicate the error. |
| | 61 | .Sh SEE ALSO |
| | 62 | .Xr pthread_rwlock_init 3 , |
| | 63 | .Xr pthread_rwlockattr_init 3 , |
| | 64 | .Xr pthread_rwlockattr_setpshared 3 |
| | 65 | .Sh STANDARDS |
| | 66 | The |
| | 67 | .Fn pthread_rwlockattr_getpshared |
| | 68 | function is expected to conform to |
| | 69 | .St -susv2 . |
| | 70 | .Sh ERRORS |
| | 71 | .Fn pthread_rwlockattr_getpshared |
| | 72 | may fail if: |
| | 73 | .Bl -tag -width Er |
| | 74 | .It Bq Er EINVAL |
| | 75 | The value specified by |
| | 76 | .Fa attr |
| | 77 | is invalid. |
| | 78 | .El |
| | 79 | .Sh HISTORY |
| | 80 | The |
| | 81 | .Fn pthread_rwlockattr_getpshared |
| | 82 | function first appeared in |
| | 83 | .Fx 3.0 . |
projects / apple / libc.git / blame_incremental