pthread_cleanup_pop()

Updated: April 19, 2023

Pop a function off of a thread's cancellation-cleanup stack

Synopsis:

#include <pthread.h>

void pthread_cleanup_pop( int execute );

Arguments:

execute
Zero if you don't want to execute the handler; nonzero if you do.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The pthread_cleanup_pop() macro pops the top cancellation-cleanup handler from the calling thread's cancellation-cleanup stack and invokes the handler if execute is nonzero.

Note: The pthread_cleanup_pop() macro expands to a few lines of code that end with a closing brace (}), but don't have a matching opening brace ({). You must pair pthread_cleanup_pop() with pthread_cleanup_push() within the same lexical scope.

Examples:

See pthread_cleanup_push().

Classification:

POSIX 1003.1

Safety:  
Cancellation point No
Interrupt handler No
Signal handler Yes
Thread Yes