posix_spawnattr_getflags()

Get the spawn-flags attribute of a spawn attributes object

Synopsis:

#include <posix_spawnattr.h>

int posix_spawnattr_getflags(
       const posix_spawnattr_t *_Restrict attrp,
       short *_Restrict flags_p);

Arguments:

attrp

A spawn attributes object attrp used by the implementation.

flags_p

A short function used for getting flag parameters.

posix_spawnattr_t

A spawn attributes object is of type posix_spawnattr_t (defined in <spawn.h>) and is used to specify the inheritance of process attributes across a spawn operation. IEEE Std 1003.1-2001 doesn't define comparison or assignment operators for the type posix_spawnattr_t.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The posix_spawnattr_getflags() function obtains the value of the spawn-flags attribute from the attributes object referenced by attrp.

---

POSIX specifies posix_spawnattr_setflags() and posix_spawnattr_getflags() routines for the setting of predefined flags using a flags_p parameter, which is defined as a short type. QNX provides several extended attributes settings and to extend the range of possible flag values using a uint32_t type for extended flags.

---

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_SETPGROUP — set process group (00000001)
• POSIX_SPAWN_SETSIGMASK — set mask to sigmask (00000002)
• POSIX_SPAWN_SETSIGDEF — set members of sigdefault to SIG_DFL (00000004)
• POSIX_SPAWN_SETSCHEDULER — set members of sigignore to SIG_IGN (00000040)
• POSIX_SPAWN_SETSCHEDPARAM — Set the scheduling policy (00000400)
• POSIX_SPAWN_RESETIDS — reset IDs (0000)

These flags are defined in <spawn.h>. The default value of this attribute shall be as if no flags were set.

These functions are part of the Spawn option and need not be provided on all implementations.

Returns:

Upon successful completion, posix_spawnattr_getflags() will return zero and store the value of the spawn-flags attribute of attrp into the object referenced by the flags_p parameter; otherwise, an error number is returned to indicate the error (errno is set).

Errors:

EINVAL

For any invalid parameter.

ENOMEM

The partition Id couldn't be added to the attributes object.

EOK

Success.

Classification:

POSIX 1003.1 RTS

See also:

posix_spawn(), posix_spawn_file_actions_addclose(), posix_spawn_file_actions_adddup2(), posix_spawn_file_actions_addopen(), posix_spawn_file_actions_destroy(), posix_spawn_file_actions_init(), posix_spawnattr_addpartid(), posix_spawnattr_addpartition(), posix_spawnattr_destroy(), posix_spawnattr_getcred(), posix_spawnattr_getnode(), posix_spawnattr_getpartid(), posix_spawnattr_getpgroup(), posix_spawnattr_getrunmask(), posix_spawnattr_getschedparam(), posix_spawnattr_getschedpolicy(), posix_spawnattr_getsigdefault(), posix_spawnattr_getsigignore(), posix_spawnattr_getsigmask(), posix_spawnattr_getstackmax(), posix_spawnattr_getxflags(), posix_spawnattr_init(), posix_spawnattr_setcred(), posix_spawnattr_setflags(), posix_spawnattr_setnode(), posix_spawnattr_setpgroup(), posix_spawnattr_setschedparam(), posix_spawnattr_setrunmask(), posix_spawnattr_setschedpolicy(), posix_spawnattr_setsigdefault(), posix_spawnattr_setsigignore(), posix_spawnattr_setsigmask(), posix_spawnattr_setstackmax(), posix_spawnattr_setxflags(), posix_spawnp()