The Open Group Base Specifications Issue 8
IEEE Std 1003.1-2024
Copyright © 2001-2024 The IEEE and The Open Group

NAME

posix_spawnattr_getflags, posix_spawnattr_setflags — get and set the spawn-flags attribute of a spawn attributes object (ADVANCED REALTIME)

SYNOPSIS

[SPN] [Option Start] #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); [Option End]

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
[PS] [Option Start]
POSIX_SPAWN_SETSCHEDPARAM
POSIX_SPAWN_SETSCHEDULER
[Option End]
POSIX_SPAWN_SETSID
POSIX_SPAWN_SETSIGDEF
POSIX_SPAWN_SETSIGMASK

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_getsigdefault, posix_spawnattr_getpgroup, posix_spawnattr_getschedparam, posix_spawnattr_getschedpolicy, posix_spawnattr_getsigmask

XBD <spawn.h>

CHANGE HISTORY

First released in Issue 6. Derived from IEEE Std 1003.1d-1999.

Issue 8

Austin Group Defect 1044 is applied, adding POSIX_SPAWN_SETSID.

End of informative text.

 

return to top of page

UNIX® is a registered Trademark of The Open Group.
POSIX™ is a Trademark of The IEEE.
Copyright © 2001-2024 The IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]