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

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH POSIX_SPAWNATTR_GETFLAGS 3C "Sep 25, 2008"
  12 .SH NAME
  13 posix_spawnattr_getflags, posix_spawnattr_setflags \- get and set spawn-flags
  14 attribute of spawn attributes object
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <spawn.h>
  19
  20 \fBint\fR \fBposix_spawnattr_getflags\fR(\fBconst posix_spawnattr_t *restrict\fR \fIattr\fR,
  21      \fBshort *restrict\fR \fIflags\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBint\fR \fBposix_spawnattr_setflags\fR(\fBposix_spawnattr_t *\fR \fIattr\fR, \fBshort\fR \fIflags\fR);
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBposix_spawnattr_getflags()\fR function obtains the value of the
  33 \fIspawn-flags\fR attribute from the attributes object referenced by
  34 \fIattr\fR.
  35 .sp
  36 .LP
  37 The \fBposix_spawnattr_setflags()\fR function sets the \fIspawn-flags\fR
  38 attribute in an initialized attributes object referenced by \fIattr\fR.
  39 .sp
  40 .LP
  41 The \fIspawn-flags\fR attribute is used to indicate which process attributes
  42 are to be changed in the new process image when invoking \fBposix_spawn\fR(3C)
  43 or \fBposix_spawnp\fR(3C). It is the bitwise inclusive-OR of zero or more of
  44 the following flags:
  45 .br
  46 .in +2
  47 \fBPOSIX_SPAWN_RESETIDS\fR
  48 .in -2
  49 .br
  50 .in +2
  51 \fBPOSIX_SPAWN_SETPGROUP\fR
  52 .in -2
  53 .br
  54 .in +2
  55 \fBPOSIX_SPAWN_SETSIGDEF\fR
  56 .in -2
  57 .br
  58 .in +2
  59 \fBPOSIX_SPAWN_SETSIGMASK\fR
  60 .in -2
  61 .br
  62 .in +2
  63 \fBPOSIX_SPAWN_SETSCHEDPARAM\fR
  64 .in -2
  65 .br
  66 .in +2
  67 \fBPOSIX_SPAWN_SETSCHEDULER\fR
  68 .in -2
  69 .br
  70 .in +2
  71 \fBPOSIX_SPAWN_NOSIGCHLD_NP\fR
  72 .in -2
  73 .br
  74 .in +2
  75 \fBPOSIX_SPAWN_WAITPID_NP\fR
  76 .in -2
  77 .br
  78 .in +2
  79 \fBPOSIX_SPAWN_NOEXECERR_NP\fR
  80 .in -2
  81 .sp
  82 .LP
  83 These flags are defined in \fB<spawn.h>\fR. The default value of this attribute
  84 is as if no flags were set.
  85 .SH RETURN VALUES
  86 .sp
  87 .LP
  88 Upon successful completion, \fBposix_spawnattr_getflags()\fR returns 0 and
  89 stores the value of the spawn-flags attribute of attr into the object
  90 referenced by the flags parameter. Otherwise, an error number is returned to
  91 indicate the error.
  92 .sp
  93 .LP
  94 Upon successful completion, \fBposix_spawnattr_setflags()\fR returns 0.
  95 Otherwise, an error number is returned to indicate the error.
  96 .SH ERRORS
  97 .sp
  98 .LP
  99 These functions may fail if:
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBEINVAL\fR\fR
 104 .ad
 105 .RS 10n
 106 The value specified by \fIattr\fR is invalid.
 107 .RE
 108
 109 .sp
 110 .LP
 111 The \fBposix_spawnattr_setflags()\fR function may fail if:
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBEINVAL\fR\fR
 116 .ad
 117 .RS 10n
 118 The value of the attribute being set is not valid.
 119 .RE
 120
 121 .SH ATTRIBUTES
 122 .sp
 123 .LP
 124 See \fBattributes\fR(5) for descriptions of the following attributes:
 125 .sp
 126
 127 .sp
 128 .TS
 129 box;
 130 c | c
 131 l | l .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 Interface Stability     Committed
 135 _
 136 MT-Level        MT-Safe
 137 _
 138 Standard        See \fBstandards\fR(5).
 139 .TE
 140
 141 .SH SEE ALSO
 142 .sp
 143 .LP
 144 \fBposix_spawn\fR(3C), \fBposix_spawnattr_destroy\fR(3C),
 145 \fBposix_spawnattr_getpgroup\fR(3C), \fBposix_spawnattr_getschedparam\fR(3C),
 146 \fBposix_spawnattr_getschedpolicy\fR(3C),
 147 \fBposix_spawnattr_getsigdefault\fR(3C), \fBposix_spawnattr_getsigmask\fR(3C),
 148 \fBattributes\fR(5), \fBstandards\fR(5)