xref: /titanic_52/usr/src/man/man3c/pthread_kill.3c (revision 6a1af1a67532df169a657cce07140be64bdea084)
te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
Copyright 1991, 1992, 1994, The X/Open Company Ltd.
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.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
pthread_kill 3C "23 Mar 2005" "SunOS 5.11" "Standard C Library Functions"
NAME
pthread_kill - send a signal to a thread
SYNOPSIS

cc -mt [ flag... ] file... -lpthread [ library... ]
#include <signal.h> 
#include <pthread.h>

int pthread_kill(pthread_t thread, int sig);
DESCRIPTION

The pthread_kill() function sends the sig signal to the thread designated by thread. The thread argument must be a member of the same process as the calling thread. The sig argument must be one of the signals listed in signal.h(3HEAD), with the exception of SIGCANCEL being reserved and off limits to pthread_kill(). If sig is 0, a validity check is performed for the existence of the target thread; no signal is sent.

RETURN VALUES

Upon successful completion, the function returns a value of 0. Otherwise the function returns an error number. If the pthread_kill() function fails, no signal is sent.

ERRORS

The pthread_kill() function will fail if:

ESRCH

No thread could be found corresponding to that specified by the given thread ID.

EINVAL

The value of the sig argument is an invalid or unsupported signal number.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStandard
MT-LevelMT-Safe
SEE ALSO

kill(1), pthread_self(3C), pthread_sigmask(3C), raise(3C), attributes(5), standards(5)