static/freebsd/man3/pthread_attr_setcreatesuspend_np.3 3.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

<table class="head">
  <tr>
    <td class="head-ltitle">PTHREAD_ATTR_SETCREATESUSPEND_NP(3)</td>
    <td class="head-vol">Library Functions Manual</td>
    <td class="head-rtitle">PTHREAD_ATTR_SETCREATESUSPEND_NP(3)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">pthread_attr_setcreatesuspend_np</code> &#x2014;
    <span class="Nd">prepare attribute for creation of suspended
  thread</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
<p class="Pp"><span class="Lb">POSIX Threads Library (libpthread,
    -lpthread)</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
    &lt;<a class="In">pthread_np.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">pthread_attr_setcreatesuspend_np</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t
    *attr</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
    <a class="permalink" href="#pthread_attr_setcreatesuspend_np"><code class="Fn" id="pthread_attr_setcreatesuspend_np">pthread_attr_setcreatesuspend_np</code></a>()
    instructs <a class="Xr">pthread_create(3)</a> that the thread created with
    the <var class="Fa">attr</var> attribute should be created and left in a
    suspended state until explicitly resumed by the call to
    <a class="permalink" href="#pthread_resume_np"><code class="Fn" id="pthread_resume_np">pthread_resume_np</code></a>()
    or
    <a class="permalink" href="#pthread_resume_all_np"><code class="Fn" id="pthread_resume_all_np">pthread_resume_all_np</code></a>().</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
  VALUES</a></h1>
<p class="Pp">The <code class="Fn">pthread_attr_setcreatesuspend_np</code>()
    function returns the value&#x00A0;0 if successful; otherwise the
    value&#x00A0;-1 is returned and the global variable
    <var class="Va">errno</var> is set to indicate the error.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
<p class="Pp">The <code class="Fn">pthread_attr_setcreatesuspend_np</code>()
    function will fail if:</p>
<dl class="Bl-tag">
  <dt id="EINVAL">[<a class="permalink" href="#EINVAL"><code class="Er">EINVAL</code></a>]</dt>
  <dd>The value specified by <var class="Fa">attr</var> is invalid.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">pthread_attr_destroy(3)</a>,
    <a class="Xr">pthread_attr_init(3)</a>, <a class="Xr">pthread_create(3)</a>,
    <a class="Xr">pthread_np(3)</a>, <a class="Xr">pthread_resume_all_np(3)</a>,
    <a class="Xr">pthread_resume_np(3)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">This manual page was written by <span class="An">Alexey
    Zelkin</span>
    &lt;<a class="Mt" href="mailto:phantom@FreeBSD.org">phantom@FreeBSD.org</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">October 12, 2021</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>