1.\" $NetBSD: pthread_condattr.3,v 1.3 2005/06/17 18:07:06 peter Exp $ 2.\" 3.\" Copyright (c) 2002 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. Neither the name of The NetBSD Foundation nor the names of its 14.\" contributors may be used to endorse or promote products derived 15.\" from this software without specific prior written permission. 16.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26.\" POSSIBILITY OF SUCH DAMAGE. 27.\" 28.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>. 29.\" All rights reserved. 30.\" 31.\" Redistribution and use in source and binary forms, with or without 32.\" modification, are permitted provided that the following conditions 33.\" are met: 34.\" 1. Redistributions of source code must retain the above copyright 35.\" notice(s), this list of conditions and the following disclaimer as 36.\" the first lines of this file unmodified other than the possible 37.\" addition of one or more copyright notices. 38.\" 2. Redistributions in binary form must reproduce the above copyright 39.\" notice(s), this list of conditions and the following disclaimer in 40.\" the documentation and/or other materials provided with the 41.\" distribution. 42.\" 43.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 44.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 45.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 46.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE 47.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 48.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 49.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 50.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 51.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 52.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 53.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 54.\" 55.\" $FreeBSD: src/lib/libpthread/man/pthread_condattr.3,v 1.10 2002/09/16 19:29:28 mini Exp $ 56.Dd January 30, 2003 57.Dt PTHREAD_CONDATTR 3 58.Os 59.Sh NAME 60.Nm pthread_condattr_init , 61.Nm pthread_condattr_destroy 62.Nd condition attribute operations 63.Sh LIBRARY 64.Lb libpthread 65.Sh SYNOPSIS 66.In pthread.h 67.Ft int 68.Fn pthread_condattr_init "pthread_condattr_t *attr" 69.Ft int 70.Fn pthread_condattr_destroy "pthread_condattr_t *attr" 71.Sh DESCRIPTION 72Condition attribute objects are used to specify parameters to 73.Fn pthread_cond_init . 74The 75.Fn pthread_condattr_init 76function initializes a condition attribute object with the default attributes. 77.Pp 78The 79.Fn pthread_condattr_destroy 80function destroys a condition attribute object. 81.Sh RETURN VALUES 82If successful, these functions return 0. 83Otherwise, an error number is returned to indicate the error. 84.Sh ERRORS 85.Fn pthread_condattr_init 86shall fail if: 87.Bl -tag -width Er 88.It Bq Er ENOMEM 89Insufficient memory exists to initialize the condition attribute object. 90.El 91.Pp 92.Fn pthread_condattr_destroy 93may fail if: 94.Bl -tag -width Er 95.It Bq Er EINVAL 96The value specified by 97.Fa attr 98is invalid. 99.El 100.Sh SEE ALSO 101.Xr pthread_cond_init 3 102.Sh STANDARDS 103.Fn pthread_condattr_init 104and 105.Fn pthread_condattr_destroy 106conform to 107.St -p1003.1-96 . 108