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.Dd November 28, 2021 36.Dt POSIX_SPAWN_FILE_ACTIONS_INIT 3 37.Os 38.Sh NAME 39.Nm posix_spawn_file_actions_init , 40.Nm posix_spawn_file_actions_destroy 41.Nd "initialize and destroy spawn file actions object" 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.In spawn.h 46.Ft int 47.Fn posix_spawn_file_actions_init "posix_spawn_file_actions_t * file_actions" 48.Ft int 49.Fn posix_spawn_file_actions_destroy "posix_spawn_file_actions_t * file_actions" 50.Sh DESCRIPTION 51The 52.Fn posix_spawn_file_actions_init 53function initialize the object referenced by 54.Fn file_actions 55to contain no file actions for 56.Fn posix_spawn 57or 58.Fn posix_spawnp . 59Initializing an already initialized spawn file actions object may cause 60memory to be leaked. 61.Pp 62The 63.Fn posix_spawn_file_actions_destroy 64function destroy the object referenced by 65.Fa file_actions ; 66the object becomes, in effect, uninitialized. 67A destroyed spawn file actions object can be reinitialized using 68.Fn posix_spawn_file_actions_init . 69The object should not be used after it has been destroyed. 70.Sh RETURN VALUES 71Upon successful completion, these functions return zero; 72otherwise, an error number is returned to indicate the error. 73.Sh ERRORS 74The 75.Fn posix_spawn_file_actions_init 76function will fail if: 77.Bl -tag -width Er 78.It Bq Er ENOMEM 79Insufficient memory exists to initialize the spawn file actions object. 80.El 81.Sh SEE ALSO 82.Xr posix_spawn 3 , 83.Xr posix_spawn_file_actions_addclose 3 , 84.Xr posix_spawn_file_actions_addclosefrom_np 3 , 85.Xr posix_spawn_file_actions_adddup2 3 , 86.Xr posix_spawn_file_actions_addopen 3 , 87.Xr posix_spawnp 3 88.Sh STANDARDS 89The 90.Fn posix_spawn_file_actions_init 91and 92.Fn posix_spawn_file_actions_destroy 93functions conform to 94.St -p1003.1-2001 . 95.Sh HISTORY 96The 97.Fn posix_spawn_file_actions_init 98and 99.Fn posix_spawn_file_actions_destroy 100functions first appeared in 101.Fx 8.0 . 102.Sh AUTHORS 103.An \&Ed Schouten Aq Mt ed@FreeBSD.org 104