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

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH POSIX_SPAWN_FILE_ACTIONS_DESTROY 3C "Jan 30, 2004"
  47 .SH NAME
  48 posix_spawn_file_actions_destroy, posix_spawn_file_actions_init \- destroy and
  49 initialize spawn file actions object
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <spawn.h>
  54
  55 \fBint\fR \fBposix_spawn_file_actions_destroy\fR(
  56      \fBposix_spawn_file_actions_t *\fR\fIfile_actions\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBint\fR \fBposix_spawn_file_actions_init\fR(
  62      \fBposix_spawn_file_actions_t *\fR\fIfile_actions\fR);
  63 .fi
  64
  65 .SH DESCRIPTION
  66 .sp
  67 .LP
  68 The \fBposix_spawn_file_actions_destroy()\fR function destroys the object
  69 referenced by \fIfile_actions\fR. The object becomes, in effect, uninitialized.
  70 An implementation can cause \fBposix_spawn_file_actions_destroy()\fR to set the
  71 object referenced by file_actions to an invalid value. A destroyed spawn file
  72 actions object can be reinitialized using
  73 \fBposix_spawn_file_actions_init()\fR. The results of otherwise referencing the
  74 object after it has been destroyed are undefined.
  75 .sp
  76 .LP
  77 The \fBposix_spawn_file_actions_init()\fR function initializes the object
  78 referenced by \fIfile_actions\fR to contain no file actions for
  79 \fBposix_spawn\fR(3C) or \fBposix_spawnp\fR(3C) to perform.
  80 .sp
  81 .LP
  82 A spawn file actions object is as defined in
  83 \fBposix_spawn_file_actions_addclose\fR(3C).
  84 .sp
  85 .LP
  86 The effect of initializing an already initialized spawn file actions object is
  87 undefined.
  88 .SH RETURN VALUES
  89 .sp
  90 .LP
  91 Upon successful completion, these functions return 0. Otherwise, an error
  92 number is returned to indicate the error.
  93 .SH ERRORS
  94 .sp
  95 .LP
  96 The \fBposix_spawn_file_actions_init()\fR function will fail if:
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBENOMEM\fR\fR
 101 .ad
 102 .RS 10n
 103 Insufficient memory exists to initialize the spawn file actions object.
 104 .RE
 105
 106 .sp
 107 .LP
 108 The \fBposix_spawn_file_actions_destroy()\fR function will may if:
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBEINVAL\fR\fR
 113 .ad
 114 .RS 10n
 115 The value specified by \fIfile_actions\fR is invalid.
 116 .RE
 117
 118 .SH ATTRIBUTES
 119 .sp
 120 .LP
 121 See \fBattributes\fR(5) for descriptions of the following attributes:
 122 .sp
 123
 124 .sp
 125 .TS
 126 box;
 127 c | c
 128 l | l .
 129 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 130 _
 131 Interface Stability     Standard
 132 _
 133 MT-Level        MT-Safe
 134 .TE
 135
 136 .SH SEE ALSO
 137 .sp
 138 .LP
 139 \fBposix_spawn\fR(3C), \fBposix_spawn_file_actions_addclose\fR(3C),
 140 \fBattributes\fR(5), \fBstandards\fR(5)