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

   1 '\" te
   2 .\" Copyright 1989 AT&T. Copyright (c) 2003, 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 SIGSETOPS 3C "Dec 19, 2003"
   7 .SH NAME
   8 sigsetops, sigemptyset, sigfillset, sigaddset, sigdelset, sigismember \-
   9 manipulate sets of signals
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <signal.h>
  14
  15 \fBint\fR \fBsigemptyset\fR(\fBsigset_t *\fR\fIset\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBsigfillset\fR(\fBsigset_t *\fR\fIset\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBsigaddset\fR(\fBsigset_t *\fR\fIset\fR, \fBint\fR \fIsigno\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBsigdelset\fR(\fBsigset_t *\fR\fIset\fR, \fBint\fR \fIsigno\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBsigismember\fR(\fBsigset_t *\fR\fIset\fR, \fBint\fR \fIsigno\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 These functions manipulate \fBsigset_t\fR data types, representing the set of
  42 signals supported by the implementation.
  43 .sp
  44 .LP
  45 The \fBsigemptyset()\fR function initializes the set pointed to by \fIset\fR to
  46 exclude all signals defined by the system.
  47 .sp
  48 .LP
  49 The \fBsigfillset()\fR function initializes the set pointed to by \fIset\fR to
  50 include all signals defined by the system.
  51 .sp
  52 .LP
  53 The \fBsigaddset()\fR function adds the individual signal specified by the
  54 value of \fIsigno\fR to the set pointed to by \fIset\fR.
  55 .sp
  56 .LP
  57 The \fBsigdelset()\fR function deletes the individual signal specified by the
  58 value of \fIsigno\fR from the set pointed to by \fIset\fR.
  59 .sp
  60 .LP
  61 The \fBsigismember()\fR function checks whether the signal specified by the
  62 value of \fIsigno\fR is a member of the set pointed to by \fIset\fR.
  63 .sp
  64 .LP
  65 Any object of type \fIsigset_t\fR must be initialized by applying either
  66 \fBsigemptyset()\fR or \fBsigfillset()\fR before applying any other operation.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 Upon successful completion, the \fBsigismember()\fR function returns \fB1\fR if
  71 the specified signal is a member of the specified set, or \fB0\fR if it is not.
  72 .sp
  73 .LP
  74 Upon successful completion, the other functions return \fB0\fR. Otherwise
  75 \fB\(mi1\fR is returned and \fBerrno\fR is set to indicate the error.
  76 .SH ERRORS
  77 .sp
  78 .LP
  79 The \fBsigaddset()\fR, \fBsigdelset()\fR, and \fBsigismember()\fR functions
  80 will fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEINVAL\fR\fR
  85 .ad
  86 .RS 10n
  87 The value of the \fIsigno\fR argument is not a valid signal number.
  88 .RE
  89
  90 .sp
  91 .LP
  92 The \fBsigfillset()\fR function will fail if:
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBEFAULT\fR\fR
  97 .ad
  98 .RS 10n
  99 The \fIset\fR argument specifies an invalid address.
 100 .RE
 101
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Standard
 116 _
 117 MT-Level        Async-Signal-Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBsigaction\fR(2), \fBsigpending\fR(2), \fBsigprocmask\fR(2),
 124 \fBsigsuspend\fR(2), \fBsignal.h\fR(3HEAD), \fBattributes\fR(5),
 125 \fBstandards\fR(5)