Poster of Linux kernelThe best gift for a Linux geek
PTHREAD_TESTCANCEL

PTHREAD_TESTCANCEL

Section: Linux Programmer's Manual (3) Updated: 2008-11-17
Local index Up
 

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_cancel() 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.  

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.27 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/.


 

Index

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

This document was created by man2html, using the manual pages.
Time: 21:53:16 GMT, April 16, 2011