NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | CONFORMING TO | EXAMPLE | SEE ALSO | COLOPHON

PTHREAD_TESTCANCEL(3)         Linux Programmer's Manual         PTHREAD_TESTCANCEL(3)

NAME         top

       pthread_testcancel - request delivery of any pending cancellation request

SYNOPSIS         top

       #include <pthread.h>

       void pthread_testcancel(void);

       Compile and link with -pthread.

DESCRIPTION         top

       Calling pthread_testcancel() creates a cancellation point within the calling
       thread, so that a thread that is otherwise executing code that contains no
       cancellation points will respond to a cancellation request.

       If cancelability is disabled (using pthread_setcancelstate(3)), or no
       cancellation request is pending, then a call to pthread_cancel() has no
       effect.

RETURN VALUE         top

       This function does not return a value.  If the calling thread is canceled as a
       consequence of a call to this function, then the function does not return.

ERRORS         top

       This function always succeeds.

CONFORMING TO         top

       POSIX.1-2001.

EXAMPLE         top

       See pthread_cleanup_push(3).

SEE ALSO         top

       pthread_cancel(3), pthread_cleanup_push(3), pthread_setcancelstate(3),
       pthreads(7)

COLOPHON         top

       This page is part of release 3.23 of the Linux man-pages project.  A
       description of the project, and information about reporting bugs, can be found
       at http://www.kernel.org/doc/man-pages/.

Linux                                 2008-11-17                PTHREAD_TESTCANCEL(3)