static/freebsd/man3/pthread_cleanup_pop.3 4.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

<table class="head">
  <tr>
    <td class="head-ltitle">PTHREAD_CLEANUP_POP(3)</td>
    <td class="head-vol">Library Functions Manual</td>
    <td class="head-rtitle">PTHREAD_CLEANUP_POP(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_cleanup_pop</code> &#x2014;
    <span class="Nd">call the first cleanup routine</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.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">void</var>
  <br/>
  <code class="Fn">pthread_cleanup_pop</code>(<var class="Fa" style="white-space: nowrap;">int
    execute</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_cleanup_pop"><code class="Fn" id="pthread_cleanup_pop">pthread_cleanup_pop</code></a>()
    function pops the top cleanup routine off of the current threads cleanup
    routine stack, and, if <var class="Fa">execute</var> is non-zero, it will
    execute the function. If there is no cleanup routine then
    <code class="Fn">pthread_cleanup_pop</code>() does nothing.</p>
<p class="Pp" id="pthread_cleanup_pop~2">The
    <a class="permalink" href="#pthread_cleanup_pop~2"><code class="Fn">pthread_cleanup_pop</code></a>()
    function is implemented as a macro that closes a block. Invocations of this
    function must appear as standalone statements that are paired with an
    earlier call of <a class="Xr">pthread_cleanup_push(3)</a> in the same
    lexical scope.</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_cleanup_pop</code>() function does
    not return any value.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
<p class="Pp">None</p>
</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_cleanup_push(3)</a>,
    <a class="Xr">pthread_exit(3)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1>
<p class="Pp">The <code class="Fn">pthread_cleanup_pop</code>() function
    conforms to <span class="St">ISO/IEC 9945-1:1996
    (&#x201C;POSIX.1&#x201D;)</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">October 25, 2014</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>