xref: /illumos-gate/usr/src/man/man3c/posix_spawn_file_actions_destroy.3c (revision fa79a855d371dfcb29461ad6ebaf48a458bf9f14)

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
http://www.opengroup.org/bookstore/.

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 SunOS 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.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.

POSIX_SPAWN_FILE_ACTIONS_DESTROY 3C "Jan 30, 2004"
NAME
posix_spawn_file_actions_destroy, posix_spawn_file_actions_init - destroy and initialize spawn file actions object
SYNOPSIS

#include <spawn.h>

int posix_spawn_file_actions_destroy(
 posix_spawn_file_actions_t *file_actions);

int posix_spawn_file_actions_init(
 posix_spawn_file_actions_t *file_actions);
DESCRIPTION

The posix_spawn_file_actions_destroy() function destroys the object referenced by file_actions. The object becomes, in effect, uninitialized. An implementation can cause posix_spawn_file_actions_destroy() to set the object referenced by file_actions to an invalid value. A destroyed spawn file actions object can be reinitialized using posix_spawn_file_actions_init(). The results of otherwise referencing the object after it has been destroyed are undefined.

The posix_spawn_file_actions_init() function initializes the object referenced by file_actions to contain no file actions for posix_spawn(3C) or posix_spawnp(3C) to perform.

A spawn file actions object is as defined in posix_spawn_file_actions_addclose(3C).

The effect of initializing an already initialized spawn file actions object is undefined.

RETURN VALUES

Upon successful completion, these functions return 0. Otherwise, an error number is returned to indicate the error.

ERRORS

The posix_spawn_file_actions_init() function will fail if: ENOMEM

Insufficient memory exists to initialize the spawn file actions object.

The posix_spawn_file_actions_destroy() function will may if: EINVAL

The value specified by file_actions is invalid.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

posix_spawn(3C), posix_spawn_file_actions_addclose(3C), attributes(5), standards(5)