lib/libc/gen/posix_spawn_file_actions_init.3

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