|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH POSIX_SPAWNATTR_GETPGROUP "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
posix_spawnattr_getpgroup,
|
|
Packit |
7cfc04 |
posix_spawnattr_setpgroup
|
|
Packit |
7cfc04 |
\(em get and set the spawn-pgroup attribute of a spawn attributes object
|
|
Packit |
7cfc04 |
(\fBADVANCED REALTIME\fP)
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <spawn.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
int posix_spawnattr_getpgroup(const posix_spawnattr_t *restrict \fIattr\fP,
|
|
Packit |
7cfc04 |
pid_t *restrict \fIpgroup\fP);
|
|
Packit |
7cfc04 |
int posix_spawnattr_setpgroup(posix_spawnattr_t *\fIattr\fP, pid_t \fIpgroup\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIposix_spawnattr_getpgroup\fR()
|
|
Packit |
7cfc04 |
function shall obtain the value of the
|
|
Packit |
7cfc04 |
.IR spawn-pgroup
|
|
Packit |
7cfc04 |
attribute from the attributes object referenced by
|
|
Packit |
7cfc04 |
.IR attr .
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIposix_spawnattr_setpgroup\fR()
|
|
Packit |
7cfc04 |
function shall set the
|
|
Packit |
7cfc04 |
.IR spawn-pgroup
|
|
Packit |
7cfc04 |
attribute in an initialized attributes object referenced by
|
|
Packit |
7cfc04 |
.IR attr .
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.IR spawn-pgroup
|
|
Packit |
7cfc04 |
attribute represents the process group to be joined by the new process
|
|
Packit |
7cfc04 |
image in a spawn operation (if POSIX_SPAWN_SETPGROUP is set in the
|
|
Packit |
7cfc04 |
.IR spawn-flags
|
|
Packit |
7cfc04 |
attribute). The default value of this attribute shall be zero.
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
Upon successful completion,
|
|
Packit |
7cfc04 |
\fIposix_spawnattr_getpgroup\fR()
|
|
Packit |
7cfc04 |
shall return zero and store the value of the
|
|
Packit |
7cfc04 |
.IR spawn-pgroup
|
|
Packit |
7cfc04 |
attribute of
|
|
Packit |
7cfc04 |
.IR attr
|
|
Packit |
7cfc04 |
into the object referenced by the
|
|
Packit |
7cfc04 |
.IR pgroup
|
|
Packit |
7cfc04 |
parameter; otherwise, an error number shall be returned to indicate the
|
|
Packit |
7cfc04 |
error.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
Upon successful completion,
|
|
Packit |
7cfc04 |
\fIposix_spawnattr_setpgroup\fR()
|
|
Packit |
7cfc04 |
shall return zero; otherwise, an error number shall be returned to
|
|
Packit |
7cfc04 |
indicate the error.
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
These functions may fail if:
|
|
Packit |
7cfc04 |
.TP
|
|
Packit |
7cfc04 |
.BR EINVAL
|
|
Packit |
7cfc04 |
The value specified by
|
|
Packit |
7cfc04 |
.IR attr
|
|
Packit |
7cfc04 |
is invalid.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIposix_spawnattr_setpgroup\fR()
|
|
Packit |
7cfc04 |
function may fail if:
|
|
Packit |
7cfc04 |
.TP
|
|
Packit |
7cfc04 |
.BR EINVAL
|
|
Packit |
7cfc04 |
The value of the attribute being set is not valid.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
These functions are part of the Spawn option and need not be
|
|
Packit |
7cfc04 |
provided on all implementations.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.ad l
|
|
Packit |
7cfc04 |
.IR "\fIposix_spawn\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIposix_spawnattr_destroy\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIposix_spawnattr_getsigdefault\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIposix_spawnattr_getflags\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIposix_spawnattr_getschedparam\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIposix_spawnattr_getschedpolicy\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIposix_spawnattr_getsigmask\fR\^(\|)"
|
|
Packit |
7cfc04 |
.ad b
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Base Definitions volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fB<spawn.h>\fP"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|