1.\" Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" Portions of this text are reprinted and reproduced in electronic form 26.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- 27.\" Portable Operating System Interface (POSIX), The Open Group Base 28.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of 29.\" Electrical and Electronics Engineers, Inc and The Open Group. In the 30.\" event of any discrepancy between this version and the original IEEE and 31.\" The Open Group Standard, the original IEEE and The Open Group Standard is 32.\" the referee document. The original Standard can be obtained online at 33.\" http://www.opengroup.org/unix/online.html. 34.\" 35.\" $FreeBSD: src/lib/libc/gen/posix_spawn_file_actions_init.3,v 1.1 2008/07/28 02:22:19 davidxu Exp $ 36.\" 37.Dd April 7, 2009 38.Dt POSIX_SPAWN_FILE_ACTIONS_INIT 3 39.Os 40.Sh NAME 41.Nm posix_spawn_file_actions_init , 42.Nm posix_spawn_file_actions_destroy 43.Nd "initialize and destroy spawn file actions object" 44.Sh LIBRARY 45.Lb libc 46.Sh SYNOPSIS 47.In spawn.h 48.Ft int 49.Fn posix_spawn_file_actions_init "posix_spawn_file_actions_t * file_actions" 50.Ft int 51.Fn posix_spawn_file_actions_destroy "posix_spawn_file_actions_t * file_actions" 52.Sh DESCRIPTION 53The 54.Fn posix_spawn_file_actions_init 55function initialize the object referenced by 56.Fa file_actions 57to contain no file actions for 58.Fn posix_spawn 59or 60.Fn posix_spawnp . 61Initializing an already initialized spawn file actions object may cause 62memory to be leaked. 63.Pp 64The 65.Fn posix_spawn_file_actions_destroy 66function destroy the object referenced by 67.Fa file_actions ; 68the object becomes, in effect, uninitialized. 69A destroyed spawn file actions object can be reinitialized using 70.Fn posix_spawn_file_actions_init . 71The object should not be used after it has been destroyed. 72.Sh RETURN VALUES 73Upon successful completion, these functions return zero; 74otherwise, an error number is returned to indicate the error. 75.Sh ERRORS 76The 77.Fn posix_spawn_file_actions_init 78function will fail if: 79.Bl -tag -width Er 80.It Bq Er ENOMEM 81Insufficient memory exists to initialize the spawn file actions object. 82.El 83.Sh SEE ALSO 84.Xr posix_spawn 3 , 85.Xr posix_spawn_file_actions_addclose 3 , 86.Xr posix_spawn_file_actions_adddup2 3 , 87.Xr posix_spawn_file_actions_addopen 3 , 88.Xr posix_spawnp 3 89.Sh STANDARDS 90The 91.Fn posix_spawn_file_actions_init 92and 93.Fn posix_spawn_file_actions_destroy 94functions conform to 95.St -p1003.1-2001 . 96.Sh HISTORY 97The 98.Fn posix_spawn_file_actions_init 99and 100.Fn posix_spawn_file_actions_destroy 101functions first appeared in 102.Fx 8.0 . 103.Sh AUTHORS 104.An \&Ed Schouten Aq Mt ed@FreeBSD.org 105