'\" te .\" Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved. .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved. .\" Portions Copyright (c) 1995 IEEE All Rights Reserved. .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/. .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. This notice shall appear on any product containing this material. .TH pthread_setcancelstate 3C "11 Jan 2012" "SunOS 5.11" "Standard C Library Functions" .SH NAME pthread_setcancelstate \- enable or disable cancellation .SH SYNOPSIS .LP .nf cc -mt [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ] #include \fBint\fR \fBpthread_setcancelstate\fR(\fBint\fR \fIstate\fR, \fBint *\fR\fIoldstate\fR); .fi .SH DESCRIPTION .sp .LP The \fBpthread_setcancelstate()\fR function atomically sets the calling thread's cancellation state to the specified \fIstate\fR and if \fIoldstate\fR is not \fINULL\fR, stores the previous cancellation \fIstate\fR in \fIoldstate\fR. .sp .LP The \fIstate\fR can be either of the following: .sp .ne 2 .mk .na \fB\fBPTHREAD_CANCEL_ENABLE\fR\fR .ad .sp .6 .RS 4n This is the default. When cancellation is deferred (deferred cancellation is also the default), cancellation occurs when the target thread reaches a cancellation point and a cancel is pending. When cancellation is asynchronous, receipt of a \fBpthread_cancel\fR(3C) call causes immediate cancellation. .RE .sp .ne 2 .mk .na \fB\fBPTHREAD_CANCEL_DISABLE\fR\fR .ad .sp .6 .RS 4n When cancellation is deferred, all cancellation requests to the target thread are held pending. When cancellation is asynchronous, all cancellation requests to the target thread are held pending; as soon as cancellation is re-enabled, pending cancellations are executed immediately. .RE .sp .LP See \fBcancellation\fR(5) for the definition of a cancellation point and a discussion of cancellation concepts. See \fBpthread_setcanceltype\fR(3C) for explanations of deferred and asynchronous cancellation. .SH RETURN VALUES .sp .LP Upon successful completion, \fBpthread_setcancelstate()\fR, returns \fB0\fR. Otherwise, an error number is returned to indicate the error. .SH ERRORS .sp .LP The \fBpthread_setcancelstate()\fR function will fail if: .sp .ne 2 .mk .na \fB\fBEINVAL\fR\fR .ad .RS 10n .rt The specified \fIstate\fR is not \fBPTHREAD_CANCEL_ENABLE\fR or \fBPTHREAD_CANCEL_DISABLE\fR. .RE .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp .TS tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ Interface StabilityCommitted _ MT-LevelMT-Safe _ StandardSee \fBstandards\fR(5). .TE .SH SEE ALSO .sp .LP \fBpthread_cancel\fR(3C), \fBpthread_cleanup_pop\fR(3C), \fBpthread_cleanup_push\fR(3C), \fBpthread_exit\fR(3C), \fBpthread_join\fR(3C), \fBpthread_setcanceltype\fR(3C), \fBpthread_testcancel\fR(3C), \fBsetjmp\fR(3C), \fBattributes\fR(5), \fBcancellation\fR(5), \fBcondition\fR(5), \fBstandards\fR(5)