'\" te
.\" Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
.\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
.\"  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  http://www.opengroup.org/bookstore/.
.\" 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.  This notice shall appear on any product containing this material. 
.TH pthread_mutexattr_init 3C "11 Jan 2012" "SunOS 5.11" "Standard C Library Functions"
.SH NAME
pthread_mutexattr_init, pthread_mutexattr_destroy \- initialize or destroy mutex attributes object
.SH SYNOPSIS
.LP
.nf
cc -mt [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
#include <pthread.h>

\fBint\fR \fBpthread_mutexattr_init\fR(\fBpthread_mutexattr_t *\fR\fIattr\fR);
.fi

.LP
.nf
\fBint\fR \fBpthread_mutexattr_destroy\fR(\fBpthread_mutexattr_t *\fR\fIattr\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBpthread_mutexattr_init()\fR function initializes a mutex attributes object \fIattr\fR with the default value for all of the attributes defined by the implementation.
.sp
.LP
The effect of initializing an already initialized mutex  attributes object is undefined.
.sp
.LP
After a mutex attributes object has been used to initialize one or more mutexes, any function affecting the attributes object (including destruction) does not affect any previously initialized mutexes.
.sp
.LP
The \fBpthread_mutexattr_destroy()\fR function destroys a mutex attributes object; the object becomes, in effect, uninitialized. An implementation may cause \fBpthread_mutexattr_destroy()\fR to set the object referenced by \fIattr\fR to an invalid value. A destroyed mutex attributes object can be re-initialized using \fBpthread_mutexattr_init()\fR; the results of otherwise referencing the object after it has been  destroyed are undefined.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBpthread_mutexattr_init()\fR and \fBpthread_mutexattr_destroy()\fR return \fB0\fR. Otherwise, an error number is returned to indicate the error.
.SH ERRORS
.sp
.LP
The \fBpthread_mutexattr_init()\fR function may fail if:
.sp
.ne 2
.mk
.na
\fB\fBENOMEM\fR\fR
.ad
.RS 10n
.rt  
Insufficient memory exists to initialize the mutex attributes object.
.RE

.sp
.LP
The \fBpthread_mutexattr_destroy()\fR function may fail if:
.sp
.ne 2
.mk
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
.rt  
The value specified by \fIattr\fR is invalid.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBpthread_cond_init\fR(3C), \fBpthread_create\fR(3C), \fBpthread_mutex_init\fR(3C), \fBpthread_mutexattr_settype\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)