usr/src/man/man3c/posix_spawn_file_actions_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 .\" 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_SPAWN_FILE_ACTIONS_DESTROY 3C "Jan 30, 2004"
  12 .SH NAME
  13 posix_spawn_file_actions_destroy, posix_spawn_file_actions_init \- destroy and
  14 initialize spawn file actions object
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <spawn.h>
  19
  20 \fBint\fR \fBposix_spawn_file_actions_destroy\fR(
  21      \fBposix_spawn_file_actions_t *\fR\fIfile_actions\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBint\fR \fBposix_spawn_file_actions_init\fR(
  27      \fBposix_spawn_file_actions_t *\fR\fIfile_actions\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBposix_spawn_file_actions_destroy()\fR function destroys the object
  34 referenced by \fIfile_actions\fR. The object becomes, in effect, uninitialized.
  35 An implementation can cause \fBposix_spawn_file_actions_destroy()\fR to set the
  36 object referenced by file_actions to an invalid value. A destroyed spawn file
  37 actions object can be reinitialized using
  38 \fBposix_spawn_file_actions_init()\fR. The results of otherwise referencing the
  39 object after it has been destroyed are undefined.
  40 .sp
  41 .LP
  42 The \fBposix_spawn_file_actions_init()\fR function initializes the object
  43 referenced by \fIfile_actions\fR to contain no file actions for
  44 \fBposix_spawn\fR(3C) or \fBposix_spawnp\fR(3C) to perform.
  45 .sp
  46 .LP
  47 A spawn file actions object is as defined in
  48 \fBposix_spawn_file_actions_addclose\fR(3C).
  49 .sp
  50 .LP
  51 The effect of initializing an already initialized spawn file actions object is
  52 undefined.
  53 .SH RETURN VALUES
  54 .sp
  55 .LP
  56 Upon successful completion, these functions return 0. Otherwise, an error
  57 number is returned to indicate the error.
  58 .SH ERRORS
  59 .sp
  60 .LP
  61 The \fBposix_spawn_file_actions_init()\fR function will fail if:
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBENOMEM\fR\fR
  66 .ad
  67 .RS 10n
  68 Insufficient memory exists to initialize the spawn file actions object.
  69 .RE
  70
  71 .sp
  72 .LP
  73 The \fBposix_spawn_file_actions_destroy()\fR function will may if:
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBEINVAL\fR\fR
  78 .ad
  79 .RS 10n
  80 The value specified by \fIfile_actions\fR is invalid.
  81 .RE
  82
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 Interface Stability     Standard
  97 _
  98 MT-Level        MT-Safe
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBposix_spawn\fR(3C), \fBposix_spawn_file_actions_addclose\fR(3C),
 105 \fBattributes\fR(5), \fBstandards\fR(5)