posix_spawnattr_getflags(3C) Standard C Library Functions posix_spawnattr_getflags(3C)NAME
posix_spawnattr_getflags, posix_spawnattr_setflags - get and set spawn-flags attribute of spawn attributes object
SYNOPSIS
#include <spawn.h>
int posix_spawnattr_getflags(const posix_spawnattr_t *restrict attr, short *restrict flags);
int posix_spawnattr_setflags(posix_spawnattr_t * attr, short flags);
DESCRIPTION
The posix_spawnattr_getflags() function obtains the value of the spawn-flags attribute from the attributes object referenced by attr.
The posix_spawnattr_setflags() function sets the spawn-flags attribute in an initialized attributes object referenced by attr.
The spawn-flags attribute is used to indicate which process attributes are to be changed in the new process image when invoking
posix_spawn(3C) or posix_spawnp(3C). It is the bitwise-inclusive OR of zero or more of the following flags:
POSIX_SPAWN_RESETIDS
POSIX_SPAWN_SETPGROUP
POSIX_SPAWN_SETSIGDEF
POSIX_SPAWN_SETSIGMASK
POSIX_SPAWN_SETSCHEDPARAM
POSIX_SPAWN_SETSCHEDULER
These flags are defined in <spawn.h>. The default value of this attribute is as if no flags were set.
RETURN VALUES
Upon successful completion, posix_spawnattr_getflags() returns 0 and stores the value of the spawn-flags attribute of attr into the object
referenced by the flags parameter. Otherwise, an error number is returned to indicate the error.
Upon successful completion, posix_spawnattr_setflags() returns 0. Otherwise, an error number is returned to indicate the error.
ERRORS
These functions may fail if:
EINVAL The value specified by attr is invalid.
The posix_spawnattr_setflags() function may fail if:
EINVAL The value of the attribute being set is not valid.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
+-----------------------------+-----------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+-----------------------------+-----------------------------+
|Interface Stability |Standard |
+-----------------------------+-----------------------------+
|MT-Level |MT-Safe |
+-----------------------------+-----------------------------+
SEE ALSO posix_spawn(3C), posix_spawnattr_destroy(3C), posix_spawnattr_getpgroup(3C), posix_spawnattr_getschedparam(3C), posix_spawnattr_getsched-
policy(3C), posix_spawnattr_getsigdefault(3C), posix_spawnattr_getsigmask(3C), attributes(5), standards(5)SunOS 5.10 30 Jan 2004 posix_spawnattr_getflags(3C)
Check Out this Related Man Page
POSIX_SPAWNATTR_GETFLAGS(P) POSIX Programmer's Manual POSIX_SPAWNATTR_GETFLAGS(P)
NAME
posix_spawnattr_getflags, posix_spawnattr_setflags - get and set the spawn-flags attribute of a spawn attributes object (ADVANCED REALTIME)
SYNOPSIS
#include <spawn.h>
int posix_spawnattr_getflags(const posix_spawnattr_t *restrict attr,
short *restrict flags);
int posix_spawnattr_setflags(posix_spawnattr_t *attr, short flags);
DESCRIPTION
The posix_spawnattr_getflags() function shall obtain the value of the spawn-flags attribute from the attributes object referenced by attr.
The posix_spawnattr_setflags() function shall set the spawn-flags attribute in an initialized attributes object referenced by attr.
The spawn-flags attribute is used to indicate which process attributes are to be changed in the new process image when invoking
posix_spawn() or posix_spawnp(). It is the bitwise-inclusive OR of zero or more of the following flags:
POSIX_SPAWN_RESETIDS
POSIX_SPAWN_SETPGROUP
POSIX_SPAWN_SETSIGDEF
POSIX_SPAWN_SETSIGMASK
POSIX_SPAWN_SETSCHEDPARAM
POSIX_SPAWN_SETSCHEDULER
These flags are defined in <spawn.h>. The default value of this attribute shall be as if no flags were set.
RETURN VALUE
Upon successful completion, posix_spawnattr_getflags() shall return zero and store the value of the spawn-flags attribute of attr into the
object referenced by the flags parameter; otherwise, an error number shall be returned to indicate the error.
Upon successful completion, posix_spawnattr_setflags() shall return zero; otherwise, an error number shall be returned to indicate the
error.
ERRORS
These functions may fail if:
EINVAL The value specified by attr is invalid.
The posix_spawnattr_setflags() function may fail if:
EINVAL The value of the attribute being set is not valid.
The following sections are informative.
EXAMPLES
None.
APPLICATION USAGE
These functions are part of the Spawn option and need not be provided on all implementations.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
posix_spawn() , posix_spawnattr_destroy() , posix_spawnattr_init() , posix_spawnattr_getsigdefault() , posix_spawnattr_getpgroup() ,
posix_spawnattr_getschedparam() , posix_spawnattr_getschedpolicy() , posix_spawnattr_getsigmask() , posix_spawnattr_setsigdefault() ,
posix_spawnattr_setpgroup() , posix_spawnattr_setschedparam() , posix_spawnattr_setschedpolicy() , posix_spawnattr_setsigmask() ,
posix_spawnp() , the Base Definitions volume of IEEE Std 1003.1-2001, <spawn.h>
COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technol-
ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE
and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained
online at http://www.opengroup.org/unix/online.html .
IEEE /The Open Group 2003 POSIX_SPAWNATTR_GETFLAGS(P)