Go to main content

man pages section 3: Basic Library Functions

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

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
  • POSIX_SPAWN_NOSIGCHLD_NP
  • POSIX_SPAWN_WAITPID_NP
  • POSIX_SPAWN_NOEXECERR_NP
  • POSIX_SPAWN_SETSID

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.

EINVAL

If both POSIX_SPAWN_SETPGROUP and POSIX_SPAWN_SETSID flags are set in the spawn-flags attribute of the spawn attributes object. These options are mutually exclusive.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe
Standard

See Also

posix_spawn(3C), posix_spawnattr_destroy(3C), posix_spawnattr_getpgroup(3C), posix_spawnattr_getschedparam(3C), posix_spawnattr_getschedpolicy(3C), posix_spawnattr_getsigdefault(3C), posix_spawnattr_getsigmask(3C), spawn.h(3HEAD), attributes(7), standards(7)