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

   1 '\" te
   2 .\" Copyright (c) 2008, 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 POSIX_SPAWNATTR_GETSIGIGNORE_NP 3C "Oct 28, 2008"
   7 .SH NAME
   8 posix_spawnattr_getsigignore_np, posix_spawnattr_setsigignore_np \- get and set
   9 spawn-sigignore attribute of spawn attributes object
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <signal.h>
  14 #include <spawn.h>
  15
  16 \fBint\fR \fBposix_spawnattr_getsigignore_np\fR(
  17      \fBconst posix_spawnattr_t *restrict\fR \fIattr\fR,
  18      \fBsigset_t *restrict\fR \fIsigignore\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBposix_spawnattr_setsigignore_np\fR(
  24      \fBposix_spawnattr_t *restrict\fR \fIattr\fR,
  25      \fBconst sigset_t *restrict\fR \fIsigignore\fR);
  26 .fi
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBposix_spawnattr_getsigignore_np()\fR function obtains the value of the
  32 \fIspawn-sigignore\fR attribute from the attributes object referenced by
  33 \fIattr\fR.
  34 .sp
  35 .LP
  36 The \fBposix_spawnattr_setsigignore_np()\fR function sets the
  37 \fIspawn-sigignore\fR attribute in an initialized attributes object referenced
  38 by \fIattr\fR.
  39 .sp
  40 .LP
  41 The \fIspawn-sigignore\fR attribute represents the set of signals to be forced
  42 to be ignored in the new process image (if \fBPOSIX_SPAWN_SETSIGIGN_NP\fR is
  43 set in the spawn-flags attribute) by a spawn operation. The default value of
  44 this attribute is an empty signal set.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 Upon successful completion, \fBposix_spawnattr_getsigignore_np()\fR returns 0
  49 and stores the value of the \fIspawn-sigignore\fR attribute of \fIattr\fR into
  50 the object referenced by the \fIsigignore\fR parameter.  Otherwise, an error
  51 value is returned to indicate the error.
  52 .sp
  53 .LP
  54 Upon successful completion, \fBposix_spawnattr_setsigignore_np()\fR returns 0.
  55 Otherwise, an error value is returned to indicate the error.
  56 .SH ERRORS
  57 .sp
  58 .LP
  59 These functions may fail if:
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBEINVAL\fR\fR
  64 .ad
  65 .RS 10n
  66 The value specified by \fIattr\fR is invalid.
  67 .RE
  68
  69 .sp
  70 .LP
  71 The \fBposix_spawnattr_setsigignore_np()\fR function may fail if:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEINVAL\fR\fR
  76 .ad
  77 .RS 10n
  78 The value of the attribute being set is not valid.
  79 .RE
  80
  81 .SH ATTRIBUTES
  82 .sp
  83 .LP
  84 See \fBattributes\fR(5) for descriptions of the following attributes:
  85 .sp
  86
  87 .sp
  88 .TS
  89 box;
  90 c | c
  91 l | l .
  92 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  93 _
  94 Interface Stability     Committed
  95 _
  96 MT-Level        MT-Safe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBposix_spawn\fR(3C), \fBposix_spawnattr_destroy\fR(3C),
 103 \fBposix_spawnattr_getflags\fR(3C), \fBposix_spawnattr_getpgroup\fR(3C),
 104 \fBposix_spawnattr_getschedparam\fR(3C),
 105 \fBposix_spawnattr_getschedpolicy\fR(3C),
 106 \fBposix_spawnattr_setsigdefault\fR(3C), \fBposix_spawnattr_setsigmask\fR(3C),
 107 \fBattributes\fR(5)
 108 .SH NOTES
 109 .sp
 110 .LP
 111 The \fBPOSIX_SPAWN_SETSIGIGN_NP\fR flag and the
 112 \fBposix_spawnattr_getsigignore_np()\fR and
 113 \fBposix_spawnattr_setsigignore_np()\fR functions are non-portable Solaris
 114 extensions to the \fBposix_spawn\fR(3C) and \fBposix_spawnp()\fR interfaces.