share/man/man3c/pthread_rwlockattr_init.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH PTHREAD_RWLOCKATTR_INIT 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_rwlockattr_init, pthread_rwlockattr_destroy \- initialize or destroy
  15 read-write lock attributes object
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  20 #include <pthread.h>
  21
  22 \fBint\fR \fBpthread_rwlockattr_init\fR(\fBpthread_rwlockattr_t\fR \fI*attr\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBpthread_rwlockattr_destroy\fR(\fBpthread_rwlockattr_t\fR \fI*attr\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBpthread_rwlockattr_init()\fR function initializes a read-write lock
  34 attributes object \fIattr\fR with the default value for all of the attributes
  35 defined by the implementation.
  36 .sp
  37 .LP
  38 Results are undefined if \fBpthread_rwlockattr_init()\fR is called specifying
  39 an already initialized read-write lock attributes object.
  40 .sp
  41 .LP
  42 After a read-write lock attributes object has been used to initialize one or
  43 more read-write locks, any function affecting the attributes object (including
  44 destruction) does not affect any previously initialized read-write locks.
  45 .sp
  46 .LP
  47 The \fBpthread_rwlockattr_destroy()\fR function destroys a read-write lock
  48 attributes object. The effect of subsequent use of the object is undefined
  49 until the object is re-initialized by another call to
  50 \fBpthread_rwlockattr_init()\fR. An implementation can cause
  51 \fBpthread_rwlockattr_destroy()\fR to set the object referenced by \fIattr\fR
  52 to an invalid value.
  53 .SH RETURN VALUES
  54 .sp
  55 .LP
  56 If successful, the \fBpthread_rwlockattr_init()\fR and
  57 \fBpthread_rwlockattr_destroy()\fR functions return \fB0\fR. Otherwise, an
  58 error number is returned to indicate the error.
  59 .SH ERRORS
  60 .sp
  61 .LP
  62 The \fBpthread_rwlockattr_init()\fR function will fail if:
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBENOMEM\fR\fR
  67 .ad
  68 .RS 10n
  69 Insufficient memory exists to initialize the read-write lock attributes object.
  70 .RE
  71
  72 .sp
  73 .LP
  74 The \fBpthread_rwlockattr_destroy()\fR function may fail if:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBEINVAL\fR\fR
  79 .ad
  80 .RS 10n
  81 The value specified by \fIattr\fR is invalid.
  82 .RE
  83
  84 .SH ATTRIBUTES
  85 .sp
  86 .LP
  87 See \fBattributes\fR(5) for descriptions of the following attributes:
  88 .sp
  89
  90 .sp
  91 .TS
  92 box;
  93 c | c
  94 l | l .
  95 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  96 _
  97 Interface Stability     Standard
  98 _
  99 MT-Level        MT-Safe
 100 .TE
 101
 102 .SH SEE ALSO
 103 .sp
 104 .LP
 105 \fBpthread_rwlock_init\fR(3C), \fBpthread_rwlock_rdlock\fR(3C),
 106 \fBpthread_rwlock_unlock\fR(3C), \fBpthread_rwlock_wrlock\fR(3C),
 107 \fBpthread_rwlockattr_getpshared\fR(3C), \fBattributes\fR(5),
 108 \fBstandards\fR(5)