1.\"	$OpenBSD: pthread_barrierattr_init.3,v 1.4 2020/04/06 00:01:08 pirofti Exp $
2.\"
3.\" Copyright (c) 2012 Paul Irofti <paul@irofti.net>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.\"
18.Dd $Mdocdate: April 6 2020 $
19.Dt PTHREAD_BARRIERATTR_INIT 3
20.Os
21.Sh NAME
22.Nm pthread_barrierattr_init ,
23.Nm pthread_barrierattr_destroy
24.Nd initialize and destroy a barrier attribute object
25.Sh SYNOPSIS
26.In pthread.h
27.Ft int
28.Fn pthread_barrierattr_init "pthread_barrierattr_t *attr"
29.Ft int
30.Fn pthread_barrierattr_destroy "pthread_barrierattr_t *attr"
31.Sh DESCRIPTION
32The
33.Fn pthread_barrierattr_init
34function creates a new barrier attribute object.
35.Pp
36The
37.Fn pthread_barrierattr_destroy
38function frees the resources allocated for
39.Fa attr .
40.Sh RETURN VALUES
41If successful,
42.Fn pthread_barrierattr_init
43and
44.Fn pthread_barrierattr_destroy
45return zero;
46otherwise an error number is returned to indicate the error.
47.Sh ERRORS
48.Fn pthread_barrierattr_init
49will fail if:
50.Bl -tag -width Er
51.It Bq Er EINVAL
52The value specified by
53.Fa attr
54is invalid.
55.It Bq Er ENOMEM
56The process cannot allocate enough memory to create another barrier attribute
57object.
58.El
59.Pp
60.Fn pthread_barrierattr_destroy
61will fail if:
62.Bl -tag -width Er
63.It Bq Er EINVAL
64The value specified by
65.Fa attr
66is invalid.
67.El
68.Sh SEE ALSO
69.Xr pthread_barrier_init 3 ,
70.Xr pthread_barrier_wait 3 ,
71.Xr pthread_barrierattr_getpshared 3
72.Sh STANDARDS
73.Fn pthread_barrierattr_init
74and
75.Fn pthread_barrierattr_destroy
76conform to
77.St -p1003.1-2008 .
78