[Go to CFHT Home Page] Man Pages
Back to Software Index  BORDER=0Manpage Top Level
    PTHREAD_TESTCANCEL(3) manual page Table of Contents

Name

pthread_testcancel - request delivery of any pending cancellation request

Synopsis


#include <pthread.h>void pthread_testcancel(void);
Compile and link with -pthread.

Description

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_testcancel() has no effect.

Return Value

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

This function always succeeds.

Attributes

Multithreading (see pthreads(7) )

The pthread_testcancel() function is thread-safe.

Conforming to

POSIX.1-2001.

Example

See pthread_cleanup_push(3) .

See Also

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

Colophon

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

Table of Contents