git.saurik.com Git - apple/libpthread.git/blob

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 .\" 3. Neither the name of the author nor the names of any co-contributors

13 .\" may be used to endorse or promote products derived from this software

14 .\" without specific prior written permission.

15 .\"

16 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND

17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE

20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

26 .\" SUCH DAMAGE.

27 .\"

28 .\" $FreeBSD$

29 .\"

30 .Dd October 25, 2014

31 .Dt PTHREAD_CLEANUP_POP 3

32 .Os

33 .Sh NAME

34 .Nm pthread_cleanup_pop

35 .Nd call the first cleanup routine

36 .Sh SYNOPSIS

37 .In pthread.h

38 .Ft void

39 .Fn pthread_cleanup_pop "int execute"

40 .Sh DESCRIPTION

41 The

42 .Fn pthread_cleanup_pop

43 function pops the top cleanup routine off of the current threads cleanup

44 routine stack, and, if

45 .Fa execute

46 is non-zero, it will execute the function.

47 If there is no cleanup routine

48 then

49 .Fn pthread_cleanup_pop

50 does nothing.

51 .Pp

52 The

53 .Fn pthread_cleanup_pop

54 function is implemented as a macro that closes a block.

55 Invocations of this function must appear as standalone statements that are

56 paired with an earlier call of

57 .Xr pthread_cleanup_push 3

58 in the same lexical scope.

59 .Sh RETURN VALUES

60 The

61 .Fn pthread_cleanup_pop

62 function does not return any value.

63 .Sh ERRORS

64 None

65 .Sh SEE ALSO

66 .Xr pthread_cleanup_push 3 ,

67 .Xr pthread_exit 3

68 .Sh STANDARDS

69 The

70 .Fn pthread_cleanup_pop

71 function conforms to

72 .St -p1003.1-96 .