usr/src/man/man2/_lwp_kill.2

   1 '\" te
   2 .\"  Copyright (c) 2001, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH _LWP_KILL 2 "Aug 8, 2001"
   7 .SH NAME
   8 _lwp_kill \- send a signal to a LWP
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/lwp.h>
  13 #include <signal.h>
  14
  15 \fBint\fR \fB_lwp_kill\fR(\fBlwpid_t\fR \fItarget_lwp\fR, \fBint\fR \fIsig\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fB_lwp_kill()\fR function sends a signal to the LWP specified by
  22 \fItarget_lwp\fR. The signal that is to be sent is specified by \fIsig\fR and
  23 must be one from the list given in \fBsignal.h\fR(3HEAD). If \fIsig\fR is 0
  24 (the null signal), error checking is performed but no signal is actually sent.
  25 This can be used to check the validity of \fItarget_lwp\fR.
  26 .sp
  27 .LP
  28 The \fItarget_lwp\fR must be an LWP within the same process as the calling LWP.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 Upon successful completion, \fB0\fR is returned. A non-zero value indicates an
  33 error.
  34 .SH ERRORS
  35 .sp
  36 .LP
  37 If any of the following conditions occur, \fB_lwp_kill()\fR fails and returns
  38 the corresponding value:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBEINVAL\fR\fR
  43 .ad
  44 .RS 10n
  45 The \fIsig\fR argument is not a valid signal number.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBESRCH\fR\fR
  52 .ad
  53 .RS 10n
  54 The \fItarget_lwp\fR argument cannot be found in the current process.
  55 .RE
  56
  57 .SH ATTRIBUTES
  58 .sp
  59 .LP
  60 See \fBattributes\fR(5)  for descriptions of the following attributes:
  61 .sp
  62
  63 .sp
  64 .TS
  65 box;
  66 c | c
  67 l | l .
  68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  69 _
  70 MT-Level        Async-Signal-Safe
  71 .TE
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fBkill\fR(2), \fBsigaction\fR(2), \fBsigprocmask\fR(2), \fBsignal.h\fR(3HEAD),
  77 \fBattributes\fR(5)