usr/src/man/man3c/posix_spawnattr_destroy.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) 2004, 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 .\" 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
   9 .\" http://www.opengroup.org/bookstore/.
  10 .\" 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.
  11 .\"  This notice shall appear on any product containing this material.
  12 .\" 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.
  13 .\" 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.
  14 .\" 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]
  15 .TH POSIX_SPAWNATTR_DESTROY 3C "Jan 30, 2004"
  16 .SH NAME
  17 posix_spawnattr_destroy, posix_spawnattr_init \- destroy and initialize spawn
  18 attributes object
  19 .SH SYNOPSIS
  20 .LP
  21 .nf
  22 #include <spawn.h>
  23
  24 \fBint\fR \fBposix_spawnattr_destroy\fR(\fBposix_spawnattr_t *\fR\fIattr\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBposix_spawnattr_init\fR(\fBposix_spawnattr_t *\fR\fIattr\fR);
  30 .fi
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBposix_spawnattr_destroy()\fR function destroys a spawn attributes
  36 object. A destroyed \fIattr\fR attributes object can be reinitialized using
  37 \fBposix_spawnattr_init()\fR. The results of otherwise referencing the object
  38 after it has been destroyed are undefined. An implementation can cause
  39 \fBposix_spawnattr_destroy()\fR to set the object referenced by \fIattr\fR to
  40 an invalid value.
  41 .sp
  42 .LP
  43 The \fBposix_spawnattr_init()\fR function initializes a spawn attributes object
  44 \fIattr\fR with the default value for all of the individual attributes used by
  45 the implementation. Results are undefined if \fBposix_spawnattr_init()\fR is
  46 called specifying an already initialized \fIattr\fR attributes object.
  47 .sp
  48 .LP
  49 A spawn attributes object is of type \fBposix_spawnattr_t\fR (defined in
  50 <\fBspawn.h\fR>) and is used to specify the inheritance of process attributes
  51 across a spawn operation.
  52 .sp
  53 .LP
  54 No attributes other than those defined by IEEE Std 1003.1-200x are provided.
  55 .sp
  56 .LP
  57 The resulting spawn attributes object (possibly modified by setting individual
  58 attribute values), is used to modify the behavior of \fBposix_spawn\fR(3C) or
  59 \fBposix_spawnp\fR(3C). After a spawn attributes object has been used to spawn
  60 a process by a call to \fBposix_spawn()\fR or \fBposix_spawnp()\fR, any
  61 function affecting the attributes object (including destruction) will not
  62 affect any process that has been spawned in this way.
  63 .SH RETURN VALUES
  64 .sp
  65 .LP
  66 Upon successful completion, \fBposix_spawnattr_destroy()\fR and
  67 \fBposix_spawnattr_init()\fR return 0. Otherwise, an error number is returned
  68 to indicate the error.
  69 .SH ERRORS
  70 .sp
  71 .LP
  72 The \fBposix_spawnattr_init()\fR function will fail if:
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBENOMEM\fR\fR
  77 .ad
  78 .RS 10n
  79 Insufficient memory exists to initialize the spawn attributes object.
  80 .RE
  81
  82 .sp
  83 .LP
  84 The \fBposix_spawnattr_destroy()\fR function may fail if:
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBEINVAL\fR\fR
  89 .ad
  90 .RS 10n
  91 The value specified by \fIattr\fR is invalid.
  92 .RE
  93
  94 .SH ATTRIBUTES
  95 .sp
  96 .LP
  97 See \fBattributes\fR(5) for descriptions of the following attributes:
  98 .sp
  99
 100 .sp
 101 .TS
 102 box;
 103 c | c
 104 l | l .
 105 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 106 _
 107 Interface Stability     Standard
 108 _
 109 MT-Level        MT-Safe
 110 .TE
 111
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBposix_spawn\fR(3C), \fBposix_spawnattr_getflags\fR(3C),
 116 \fBposix_spawnattr_getpgroup\fR(3C), \fBposix_spawnattr_getschedparam\fR(3C),
 117 \fBposix_spawnattr_getschedpolicy\fR(3C),
 118 \fBposix_spawnattr_getsigdefault\fR(3C), \fBposix_spawnattr_getsigmask\fR(3C),
 119 \fBattributes\fR(5), \fBstandards\fR(5)