Blame man-pages-posix-2013-a/man3p/posix_spawn_file_actions_destroy.3p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH POSIX_SPAWN_FILE_ACTIONS_DESTROY "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
posix_spawn_file_actions_destroy,
Packit 7cfc04
posix_spawn_file_actions_init
Packit 7cfc04
\(em destroy and initialize spawn file actions object
Packit 7cfc04
(\fBADVANCED REALTIME\fP)
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
#include <spawn.h>
Packit 7cfc04
.P
Packit 7cfc04
int posix_spawn_file_actions_destroy(posix_spawn_file_actions_t
Packit 7cfc04
    *\fIfile_actions\fP);
Packit 7cfc04
int posix_spawn_file_actions_init(posix_spawn_file_actions_t
Packit 7cfc04
    *\fIfile_actions\fP);
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
\fIposix_spawn_file_actions_destroy\fR()
Packit 7cfc04
function shall destroy the object referenced by
Packit 7cfc04
.IR file_actions ;
Packit 7cfc04
the object becomes, in effect, uninitialized. An implementation may
Packit 7cfc04
cause
Packit 7cfc04
\fIposix_spawn_file_actions_destroy\fR()
Packit 7cfc04
to set the object referenced by
Packit 7cfc04
.IR file_actions
Packit 7cfc04
to an invalid value. A destroyed spawn file actions object can be
Packit 7cfc04
reinitialized using
Packit 7cfc04
\fIposix_spawn_file_actions_init\fR();
Packit 7cfc04
the results of otherwise referencing the object after it has been
Packit 7cfc04
destroyed are undefined.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
\fIposix_spawn_file_actions_init\fR()
Packit 7cfc04
function shall initialize the object referenced by
Packit 7cfc04
.IR file_actions
Packit 7cfc04
to contain no file actions for
Packit 7cfc04
\fIposix_spawn\fR()
Packit 7cfc04
or
Packit 7cfc04
\fIposix_spawnp\fR()
Packit 7cfc04
to perform.
Packit 7cfc04
.P
Packit 7cfc04
A spawn file actions object is as defined in
Packit 7cfc04
.IR "\fIposix_spawn_file_actions_addclose\fR\^(\|)".
Packit 7cfc04
.P
Packit 7cfc04
The effect of initializing an already initialized spawn file actions
Packit 7cfc04
object is undefined.
Packit 7cfc04
.SH "RETURN VALUE"
Packit 7cfc04
Upon successful completion, these functions shall return zero;
Packit 7cfc04
otherwise, an error number shall be returned to indicate the error.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
The
Packit 7cfc04
\fIposix_spawn_file_actions_init\fR()
Packit 7cfc04
function shall fail if:
Packit 7cfc04
.TP
Packit 7cfc04
.BR ENOMEM
Packit 7cfc04
Insufficient memory exists to initialize the spawn file actions object.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
\fIposix_spawn_file_actions_destroy\fR()
Packit 7cfc04
function may fail if:
Packit 7cfc04
.TP
Packit 7cfc04
.BR EINVAL
Packit 7cfc04
The value specified by
Packit 7cfc04
.IR file_actions
Packit 7cfc04
is invalid.
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
These functions are part of the Spawn option and need not be
Packit 7cfc04
provided on all implementations.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
Refer to the RATIONALE section in
Packit 7cfc04
.IR "\fIposix_spawn_file_actions_addclose\fR\^(\|)".
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIposix_spawn\fR\^(\|)",
Packit 7cfc04
.IR "\fIposix_spawn_file_actions_addclose\fR\^(\|)"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "\fB<spawn.h>\fP"
Packit 7cfc04
.br
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .