| | 1 | .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>. |
| | 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(s), this list of conditions and the following disclaimer as |
| | 9 | .\" the first lines of this file unmodified other than the possible |
| | 10 | .\" addition of one or more copyright notices. |
| | 11 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| | 12 | .\" notice(s), this list of conditions and the following disclaimer in |
| | 13 | .\" the documentation and/or other materials provided with the |
| | 14 | .\" distribution. |
| | 15 | .\" |
| | 16 | .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY |
| | 17 | .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| | 18 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| | 19 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE |
| | 20 | .\" 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 |
| | 23 | .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| | 24 | .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE |
| | 25 | .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |
| | 26 | .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| | 27 | .\" |
| | 28 | .\" $FreeBSD: src/lib/libc_r/man/pthread_condattr.3,v 1.9 2001/10/01 16:09:09 ru Exp $ |
| | 29 | .Dd April 28, 2000 |
| | 30 | .Dt PTHREAD_CONDATTR 3 |
| | 31 | .Os |
| | 32 | .Sh NAME |
| | 33 | .Nm pthread_condattr_destroy , |
| | 34 | .Nm pthread_condattr_init |
| | 35 | .Nd condition attribute operations |
| | 36 | .Sh SYNOPSIS |
| | 37 | .In pthread.h |
| | 38 | .Ft int |
| | 39 | .Fo pthread_condattr_destroy |
| | 40 | .Fa "pthread_condattr_t *attr" |
| | 41 | .Fc |
| | 42 | .Ft int |
| | 43 | .Fo pthread_condattr_init |
| | 44 | .Fa "pthread_condattr_t *attr" |
| | 45 | .Fc |
| | 46 | .Sh DESCRIPTION |
| | 47 | Condition attribute objects are used to specify parameters to |
| | 48 | .Fn pthread_cond_init . |
| | 49 | .Fx Ns 's |
| | 50 | implementation of conditions does not support any non-default |
| | 51 | attributes, so these functions are not very useful, though they are required to |
| | 52 | to be present by |
| | 53 | .Tn POSIX . |
| | 54 | .Pp |
| | 55 | The |
| | 56 | .Fn pthread_condattr_init |
| | 57 | function initializes a condition attribute object with the default attributes. |
| | 58 | .Pp |
| | 59 | The |
| | 60 | .Fn pthread_condattr_destroy |
| | 61 | function destroys a condition attribute object. |
| | 62 | .Sh RETURN VALUES |
| | 63 | If successful, these functions return 0. |
| | 64 | Otherwise, an error number is returned to indicate the error. |
| | 65 | .Sh ERRORS |
| | 66 | .Fn pthread_condattr_destroy |
| | 67 | will fail if: |
| | 68 | .Bl -tag -width Er |
| | 69 | .It Bq Er EINVAL |
| | 70 | Invalid value for |
| | 71 | .Fa attr . |
| | 72 | .El |
| | 73 | .Pp |
| | 74 | .Fn pthread_condattr_init |
| | 75 | will fail if: |
| | 76 | .Bl -tag -width Er |
| | 77 | .It Bq Er ENOMEM |
| | 78 | Out of memory. |
| | 79 | .El |
| | 80 | .Sh SEE ALSO |
| | 81 | .Xr pthread_cond_init 3 |
| | 82 | .Sh STANDARDS |
| | 83 | .Fn pthread_condattr_init |
| | 84 | and |
| | 85 | .Fn pthread_condattr_destroy |
| | 86 | conform to |
| | 87 | .St -p1003.1-96 |
projects / apple / libpthread.git / blame_incremental