lib/libc/gen/posix_spawnattr_init.3

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