1
by Francesco Paolo Lovergine
rules: linking manpages-posix not manpages. |
1 |
.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved |
2
by Francesco Paolo Lovergine
* Alligned to linux main manpages edition. |
2 |
.TH "POSIX_SPAWN_FILE_ACTIONS_DESTROY" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual" |
1
by Francesco Paolo Lovergine
rules: linking manpages-posix not manpages. |
3 |
.\" posix_spawn_file_actions_destroy |
4 |
.SH NAME |
|
5 |
posix_spawn_file_actions_destroy, posix_spawn_file_actions_init \-
|
|
6 |
destroy and initialize spawn file actions object |
|
7 |
(\fBADVANCED REALTIME\fP) |
|
8 |
.SH SYNOPSIS |
|
9 |
.LP
|
|
10 |
\fB#include <spawn.h>
|
|
11 |
.br
|
|
12 |
.sp
|
|
13 |
int posix_spawn_file_actions_destroy(posix_spawn_file_actions_t * |
|
14 |
.br
|
|
15 |
\ \ \ \ \ \ \fP \fIfile_actions\fP\fB); |
|
16 |
.br
|
|
17 |
int posix_spawn_file_actions_init(posix_spawn_file_actions_t * |
|
18 |
.br
|
|
19 |
\ \ \ \ \ \ \fP \fIfile_actions\fP\fB); \fP |
|
20 |
\fB
|
|
21 |
.br
|
|
22 |
\fP
|
|
23 |
.SH DESCRIPTION |
|
24 |
.LP
|
|
25 |
The \fIposix_spawn_file_actions_destroy\fP() function shall destroy |
|
26 |
the object referenced by \fIfile_actions\fP; the object |
|
27 |
becomes, in effect, uninitialized. An implementation may cause \fIposix_spawn_file_actions_destroy\fP() |
|
28 |
to set the object |
|
29 |
referenced by \fIfile_actions\fP to an invalid value. A destroyed |
|
30 |
spawn file actions object can be reinitialized using |
|
31 |
\fIposix_spawn_file_actions_init\fP(); the results of otherwise referencing |
|
32 |
the object after it has been destroyed are |
|
33 |
undefined. |
|
34 |
.LP
|
|
35 |
The \fIposix_spawn_file_actions_init\fP() function shall initialize |
|
36 |
the object referenced by \fIfile_actions\fP to contain no |
|
37 |
file actions for \fIposix_spawn\fP() or \fIposix_spawnp\fP() to perform. |
|
38 |
.LP
|
|
39 |
A spawn file actions object is as defined in \fIposix_spawn_file_actions_addclose\fP() |
|
40 |
\&.
|
|
41 |
.LP
|
|
42 |
The effect of initializing an already initialized spawn file actions |
|
43 |
object is undefined. |
|
44 |
.SH RETURN VALUE |
|
45 |
.LP
|
|
46 |
Upon successful completion, these functions shall return zero; otherwise, |
|
47 |
an error number shall be returned to indicate the |
|
48 |
error. |
|
49 |
.SH ERRORS |
|
50 |
.LP
|
|
51 |
The \fIposix_spawn_file_actions_init\fP() function shall fail if: |
|
52 |
.TP 7 |
|
53 |
.B ENOMEM |
|
54 |
Insufficient memory exists to initialize the spawn file actions object. |
|
55 |
.sp
|
|
56 |
.LP
|
|
57 |
The \fIposix_spawn_file_actions_destroy\fP() function may fail if: |
|
58 |
.TP 7 |
|
59 |
.B EINVAL |
|
60 |
The value specified by \fIfile_actions\fP is invalid. |
|
61 |
.sp
|
|
62 |
.LP
|
|
63 |
\fIThe following sections are informative.\fP |
|
64 |
.SH EXAMPLES |
|
65 |
.LP
|
|
66 |
None. |
|
67 |
.SH APPLICATION USAGE |
|
68 |
.LP
|
|
69 |
These functions are part of the Spawn option and need not be provided |
|
70 |
on all implementations. |
|
71 |
.SH RATIONALE |
|
72 |
.LP
|
|
73 |
Refer to the RATIONALE in \fIposix_spawn_file_actions_addclose\fP() |
|
74 |
\&.
|
|
75 |
.SH FUTURE DIRECTIONS |
|
76 |
.LP
|
|
77 |
None. |
|
78 |
.SH SEE ALSO |
|
79 |
.LP
|
|
80 |
\fIposix_spawn\fP() , \fIposix_spawnp\fP() , the Base |
|
81 |
Definitions volume of IEEE\ Std\ 1003.1-2001, \fI<spawn.h>\fP |
|
82 |
.SH COPYRIGHT |
|
83 |
Portions of this text are reprinted and reproduced in electronic form |
|
84 |
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology |
|
85 |
-- Portable Operating System Interface (POSIX), The Open Group Base |
|
86 |
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of |
|
87 |
Electrical and Electronics Engineers, Inc and The Open Group. In the |
|
88 |
event of any discrepancy between this version and the original IEEE and |
|
89 |
The Open Group Standard, the original IEEE and The Open Group Standard |
|
90 |
is the referee document. The original Standard can be obtained online at |
|
91 |
http://www.opengroup.org/unix/online.html . |