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 March 24, 2008 36.Dt POSIX_SPAWNATTR_INIT 3 37.Os 38.Sh NAME 39.Nm posix_spawnattr_init , 40.Nm posix_spawnattr_destroy 41.Nd "initialize and destroy spawn attributes object" 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.In spawn.h 46.Ft int 47.Fn posix_spawnattr_init "posix_spawnattr_t * attr" 48.Ft int 49.Fn posix_spawnattr_destroy "posix_spawnattr_t * attr" 50.Sh DESCRIPTION 51The 52.Fn posix_spawnattr_init 53function initializes a spawn attributes object 54.Fa attr 55with the default value for all of the individual attributes used by the 56implementation. 57Initializing an already initialized spawn attributes object may cause 58memory to be leaked. 59.Pp 60The 61.Fn posix_spawnattr_destroy 62function destroys a spawn attributes object. 63A destroyed 64.Fa attr 65attributes object can be reinitialized using 66.Fn posix_spawnattr_init . 67The object should not be used after it has been destroyed. 68.Pp 69A spawn attributes object is of type 70.Vt posix_spawnattr_t 71(defined in 72.In spawn.h ) 73and is used to specify the inheritance of process attributes across a 74spawn operation. 75.Pp 76The resulting spawn attributes object (possibly modified by setting 77individual attribute values), is used to modify the behavior of 78.Fn posix_spawn 79or 80.Fn posix_spawnp . 81After a spawn attributes object has been used to spawn a process by a 82call to a 83.Fn posix_spawn 84or 85.Fn posix_spawnp , 86any function affecting the attributes object (including destruction) 87will not affect any process that has been spawned in this way. 88.Sh RETURN VALUES 89Upon successful completion, 90.Fn posix_spawnattr_init 91and 92.Fn posix_spawnattr_destroy 93return zero; 94otherwise, an error number is returned to indicate the error. 95.Sh ERRORS 96The 97.Fn posix_spawnattr_init 98function will fail if: 99.Bl -tag -width Er 100.It Bq Er ENOMEM 101Insufficient memory exists to initialize the spawn attributes object. 102.El 103.Sh SEE ALSO 104.Xr posix_spawn 3 , 105.Xr posix_spawnp 3 106.Sh STANDARDS 107The 108.Fn posix_spawnattr_init 109and 110.Fn posix_spawnattr_destroy 111functions conform to 112.St -p1003.1-2001 . 113.Sh HISTORY 114The 115.Fn posix_spawnattr_init 116and 117.Fn posix_spawnattr_destroy 118functions first appeared in 119.Fx 8.0 . 120.Sh AUTHORS 121.An \&Ed Schouten Aq Mt ed@FreeBSD.org 122