'\" et

.TH POSIX_SPAWNATTR_GETFLAGS "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"

.SH PROLOG

This manual page is part of the POSIX Programmer's Manual.

The Linux implementation of this interface may differ (consult

the corresponding Linux manual page for details of Linux behavior),

or the interface may not be implemented on Linux.

.SH NAME

posix_spawnattr_getflags,

posix_spawnattr_setflags

\(em get and set the spawn-flags attribute of a spawn attributes object

(\fBADVANCED REALTIME\fP)

.SH SYNOPSIS

.LP

.nf

#include <spawn.h>

.P

int posix_spawnattr_getflags(const posix_spawnattr_t *restrict \fIattr\fP,

    short *restrict \fIflags\fP);

int posix_spawnattr_setflags(posix_spawnattr_t *\fIattr\fP, short \fIflags\fP);

.fi

.SH DESCRIPTION

The

\fIposix_spawnattr_getflags\fR()

function shall obtain the value of the

.IR spawn-flags

attribute from the attributes object referenced by

.IR attr .

.P

The

\fIposix_spawnattr_setflags\fR()

function shall set the

.IR spawn-flags

attribute in an initialized attributes object referenced by

.IR attr .

.P

The

.IR spawn-flags

attribute is used to indicate which process attributes are to be

changed in the new process image when invoking

\fIposix_spawn\fR()

or

\fIposix_spawnp\fR().

It is the bitwise-inclusive OR of zero or more of the following flags:

.P

.nf

POSIX_SPAWN_RESETIDS

POSIX_SPAWN_SETPGROUP

POSIX_SPAWN_SETSIGDEF

POSIX_SPAWN_SETSIGMASK

POSIX_SPAWN_SETSCHEDPARAM

POSIX_SPAWN_SETSCHEDULER

.fi

.P

These flags are defined in

.IR <spawn.h> .

The default value of this attribute shall be as if no flags were set.

.SH "RETURN VALUE"

Upon successful completion,

\fIposix_spawnattr_getflags\fR()

shall return zero and store the value of the

.IR spawn-flags

attribute of

.IR attr

into the object referenced by the

.IR flags

parameter; otherwise, an error number shall be returned to indicate the

error.

.P

Upon successful completion,

\fIposix_spawnattr_setflags\fR()

shall return zero; otherwise, an error number shall be returned to

indicate the error.

.SH ERRORS

These functions may fail if:

.TP

.BR EINVAL

The value specified by

.IR attr

is invalid.

.P

The

\fIposix_spawnattr_setflags\fR()

function may fail if:

.TP

.BR EINVAL

The value of the attribute being set is not valid.

.LP

.IR "The following sections are informative."

.SH EXAMPLES

None.

.SH "APPLICATION USAGE"

These functions are part of the Spawn option and need not be

provided on all implementations.

.SH RATIONALE

None.

.SH "FUTURE DIRECTIONS"

None.

.SH "SEE ALSO"

.ad l

.IR "\fIposix_spawn\fR\^(\|)",

.IR "\fIposix_spawnattr_destroy\fR\^(\|)",

.IR "\fIposix_spawnattr_getsigdefault\fR\^(\|)",

.IR "\fIposix_spawnattr_getpgroup\fR\^(\|)",

.IR "\fIposix_spawnattr_getschedparam\fR\^(\|)",

.IR "\fIposix_spawnattr_getschedpolicy\fR\^(\|)",

.IR "\fIposix_spawnattr_getsigmask\fR\^(\|)"

.ad b

.P

The Base Definitions volume of POSIX.1\(hy2008,

.IR "\fB<spawn.h>\fP"

.SH COPYRIGHT

Portions of this text are reprinted and reproduced in electronic form

from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology

-- Portable Operating System Interface (POSIX), The Open Group Base

Specifications Issue 7, Copyright (C) 2013 by the Institute of

Electrical and Electronics Engineers, Inc and The Open Group.

(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/online.html .

Any typographical or formatting errors that appear

in this page are most likely

to have been introduced during the conversion of the source files to

man page format. To report such errors, see

https://www.kernel.org/doc/man-pages/reporting_bugs.html .