usr/src/man/man3c/thr_kill.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright (c) 1995 IEEE.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH THR_KILL 3C "Mar 23, 2005"
  48 .SH NAME
  49 thr_kill \- send a signal to a thread
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc -mt [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
  54 #include <signal.h>
  55 #include <thread.h>
  56
  57 \fBint\fR \fBthr_kill\fR(\fBthread_t\fR \fIthread\fR, \fBint\fR \fIsig\fR);
  58 .fi
  59
  60 .SH DESCRIPTION
  61 .sp
  62 .LP
  63 The \fBthr_kill()\fR function sends the \fIsig\fR signal to the thread
  64 designated by \fIthread\fR. The \fIthread\fR argument must be a member of the
  65 same process as the calling thread. The \fIsig\fR argument must be one of the
  66 signals listed in \fBsignal.h\fR(3HEAD), with the exception of \fBSIGCANCEL\fR
  67 being reserved and off limits to \fBthr_kill()\fR. If \fIsig\fR is \fB0\fR, a
  68 validity check is done for the existence of the target thread; no signal is
  69 sent.
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 Upon successful completion, \fBthr_kill()\fR returns \fB0\fR. Otherwise,  an
  74 error number is returned. In the event of failure, no signal is sent.
  75 .SH ERRORS
  76 .sp
  77 .LP
  78 The \fBthr_kill()\fR function will fail if:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBEINVAL\fR\fR
  83 .ad
  84 .RS 10n
  85 The \fIsig\fR argument value is not zero and is an invalid or an  unsupported
  86 signal number.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBESRCH\fR\fR
  93 .ad
  94 .RS 10n
  95 No thread was found that corresponded to the thread designated by \fIthread\fR
  96 ID.
  97 .RE
  98
  99 .SH ATTRIBUTES
 100 .sp
 101 .LP
 102 See \fBattributes\fR(5) for descriptions of the following attributes:
 103 .sp
 104
 105 .sp
 106 .TS
 107 box;
 108 c | c
 109 l | l .
 110 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 111 _
 112 MT-Level        Async-Signal-Safe
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBkill\fR(2), \fBsigaction\fR(2), \fBraise\fR(3C), \fBsignal.h\fR(3HEAD),
 119 \fBthr_self\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)