PTHREADCANCEL(3) BSD Library Functions Manual PTHREADCANCEL(3)

NAME
     pptthhrreeaaddccaanncceell - cancel execution of a thread

SYNOPSIS
     ##iinncclluuddee <>

     int
     pptthhrreeaaddccaanncceell(pthreadt thread);

DESCRIPTION
     The pptthhrreeaaddccaanncceell() function requests that thread be canceled.  The tar-
     get thread's cancelability state and type determines when the cancella-
     tion takes effect.  When the cancellation is acted on, the cancellation
     cleanup handlers for thread are called.  When the last cancellation
     cleanup handler returns, the thread-specific data destructor functions
     will be called for thread.  When the last destructor function returns,
     thread will be terminated.

     The cancellation processing in the target thread runs asynchronously with
     respect to the calling thread returning from pptthhrreeaaddccaanncceell().

     A status of PTHREADCANCELED is made available to any threads joining
     with the target.  The symbolic constant PTHREADCANCELED expands to a
     constant expression of type (void *), whose value matches no pointer to
     an object in memory nor the value NULL.

RETURN VALUES
     If successful,  the pptthhrreeaaddccaanncceell() functions will return zero.  Other-
     wise an error number will be returned to indicate the error.

EERRRROORRSS
     pptthhrreeaaddccaanncceell() will fail if:

     [ESRCH]            No thread could be found corresponding to that speci-
                        fied by the given thread ID.

SEE ALSO
     pthreadcleanuppop(3), pthreadcleanuppush(3), pthreadexit(3),
     pthreadjoin(3), pthreadsetcancelstate(3), pthreadsetcanceltype(3),
     pthreadtestcancel(3)

STANDARDS
     pptthhrreeaaddccaanncceell() conforms to ISO/IEC 9945-1:1996 (``POSIX.1'').

AUTHORS     This man page was written by David Leonard  for the
     OpenBSD implementation of pptthhrreeaaddccaanncceell().

BSD                            January 17, 1999                            BSD