pthread_testcancel(3)

pthread_testcancel3

Request delivery of any pending cancelation request

Usage

#include <pthread.h>

void pthread_testcancel(void);

Library

POSIX threads library (libpthread, -lpthread)

Overview

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

If cancelability is disabled (using pthread_setcancelstate(3)), or no cancelation 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

For an explanation of the terms used in this section, see attributes(7).

InterfaceAttributeValue
pthread_testcancel()Thread safetyMT-Safe

Examples

See pthread_cleanup_push(3).

Releases

10 releases since Debian 5.0 (Lenny); the text changed 9 times.

  1. 5.0
  2. 6.0
  3. 7
  4. 8
  5. 9
  6. 10
  7. 11
  8. 12
  9. 13
  10. Arch

Standards

POSIX.1-2008.

History

glibc 2.0. POSIX.1-2001.

From man-pages 6.19-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.