xref: /freebsd/share/man/man3/pthread_attr_setcreatesuspend_np.3 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1.\" Copyright (c) 2003 Alexey Zelkin <phantom@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, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd February 13, 2003
28.Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
29.Os
30.Sh NAME
31.Nm pthread_attr_setcreatesuspend_np
32.Nd prepare attribute for creation of suspended thread
33.Sh LIBRARY
34.Lb libpthread
35.Sh SYNOPSIS
36.In pthread_np.h
37.Ft int
38.Fn pthread_attr_setcreatesuspend_np "pthread_attr_t *attr"
39.Sh DESCRIPTION
40The
41.Fn pthread_attr_setcreatesuspend_np
42instructs
43.Xr pthread_create 3
44that the thread created with the
45.Fa attr
46attribute
47should be created and left in a suspended state until explicitly resumed
48by the call to
49.Fn pthread_resume_np
50or
51.Fn pthread_resume_all_np .
52.Sh RETURN VALUES
53.Rv -std pthread_attr_setcreatesuspend_np
54.Sh ERRORS
55The
56.Fn pthread_attr_setcreatesuspend_np
57function will fail if:
58.Bl -tag -width Er
59.It Bq Er EINVAL
60The value specified by
61.Fa attr
62is invalid.
63.El
64.Sh SEE ALSO
65.Xr pthread_attr_destroy 3 ,
66.Xr pthread_attr_init 3 ,
67.Xr pthread_create 3 ,
68.Xr pthread_resume_all_np 3 ,
69.Xr pthread_resume_np 3
70.Sh AUTHORS
71This manual page was written by
72.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
73