xref: /freebsd/share/man/man3/pthread_condattr.3 (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
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$
29.Dd April 28, 2000
30.Dt PTHREAD_CONDATTR 3
31.Os
32.Sh NAME
33.Nm pthread_condattr_init ,
34.Nm pthread_condattr_destroy
35.Nd condition attribute operations
36.Sh LIBRARY
37.Lb libpthread
38.Sh SYNOPSIS
39.In pthread.h
40.Ft int
41.Fn pthread_condattr_init "pthread_condattr_t *attr"
42.Ft int
43.Fn pthread_condattr_destroy "pthread_condattr_t *attr"
44.Sh DESCRIPTION
45Condition attribute objects are used to specify parameters to
46.Fn pthread_cond_init .
47.Fx Ns 's
48implementation of conditions does not support any non-default
49attributes, so these functions are not very useful, though they are required
50to be present by
51.Tn POSIX .
52.Pp
53The
54.Fn pthread_condattr_init
55function initializes a condition attribute object with the default attributes.
56.Pp
57The
58.Fn pthread_condattr_destroy
59function destroys a condition attribute object.
60.Sh RETURN VALUES
61If successful, these functions return 0.
62Otherwise, an error number is returned to indicate the error.
63.Sh ERRORS
64The
65.Fn pthread_condattr_init
66function will fail if:
67.Bl -tag -width Er
68.It Bq Er ENOMEM
69Out of memory.
70.El
71.Pp
72The
73.Fn pthread_condattr_destroy
74function will fail if:
75.Bl -tag -width Er
76.It Bq Er EINVAL
77Invalid value for
78.Fa attr .
79.El
80.Sh SEE ALSO
81.Xr pthread_cond_init 3
82.Sh STANDARDS
83The
84.Fn pthread_condattr_init
85and
86.Fn pthread_condattr_destroy
87functions conform to
88.St -p1003.1-96
89