2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
|
2007-06-20 22:33:04 +00:00
|
|
|
.TH "POSIX_SPAWNATTR_GETPGROUP" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" posix_spawnattr_getpgroup
|
2007-09-20 06:03:25 +00:00
|
|
|
.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.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
posix_spawnattr_getpgroup, posix_spawnattr_setpgroup \- get and set
|
|
|
|
the spawn\-pgroup attribute of a spawn attributes
|
|
|
|
object (\fBADVANCED REALTIME\fP)
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.LP
|
|
|
|
\fB#include <spawn.h>
|
|
|
|
.br
|
|
|
|
.sp
|
|
|
|
int posix_spawnattr_getpgroup(const posix_spawnattr_t *restrict\fP
|
|
|
|
\fIattr\fP\fB,
|
|
|
|
.br
|
|
|
|
\ \ \ \ \ \ pid_t *restrict\fP \fIpgroup\fP\fB);
|
|
|
|
.br
|
|
|
|
int posix_spawnattr_setpgroup(posix_spawnattr_t *\fP\fIattr\fP\fB,
|
|
|
|
pid_t\fP \fIpgroup\fP\fB); \fP
|
|
|
|
\fB
|
|
|
|
.br
|
|
|
|
\fP
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.LP
|
|
|
|
The \fIposix_spawnattr_getpgroup\fP() function shall obtain the value
|
|
|
|
of the \fIspawn-pgroup\fP attribute from the attributes
|
|
|
|
object referenced by \fIattr\fP.
|
|
|
|
.LP
|
|
|
|
The \fIposix_spawnattr_setpgroup\fP() function shall set the \fIspawn-pgroup\fP
|
|
|
|
attribute in an initialized attributes object
|
|
|
|
referenced by \fIattr\fP.
|
|
|
|
.LP
|
|
|
|
The \fIspawn-pgroup\fP attribute represents the process group to be
|
|
|
|
joined by the new process image in a spawn operation (if
|
|
|
|
POSIX_SPAWN_SETPGROUP is set in the \fIspawn-flags\fP attribute).
|
|
|
|
The default value of this attribute shall be zero.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
.LP
|
|
|
|
Upon successful completion, \fIposix_spawnattr_getpgroup\fP() shall
|
|
|
|
return zero and store the value of the \fIspawn-pgroup\fP
|
|
|
|
attribute of \fIattr\fP into the object referenced by the \fIpgroup\fP
|
|
|
|
parameter; otherwise, an error number shall be returned to
|
|
|
|
indicate the error.
|
|
|
|
.LP
|
|
|
|
Upon successful completion, \fIposix_spawnattr_setpgroup\fP() shall
|
|
|
|
return zero; otherwise, an error number shall be returned
|
|
|
|
to indicate the error.
|
|
|
|
.SH ERRORS
|
|
|
|
.LP
|
|
|
|
These functions may fail if:
|
|
|
|
.TP 7
|
|
|
|
.B EINVAL
|
|
|
|
The value specified by \fIattr\fP is invalid.
|
|
|
|
.sp
|
|
|
|
.LP
|
|
|
|
The \fIposix_spawnattr_setpgroup\fP() function may fail if:
|
|
|
|
.TP 7
|
|
|
|
.B EINVAL
|
|
|
|
The value of the attribute being set is not valid.
|
|
|
|
.sp
|
|
|
|
.LP
|
|
|
|
\fIThe following sections are informative.\fP
|
|
|
|
.SH EXAMPLES
|
|
|
|
.LP
|
|
|
|
None.
|
|
|
|
.SH APPLICATION USAGE
|
|
|
|
.LP
|
|
|
|
These functions are part of the Spawn option and need not be provided
|
|
|
|
on all implementations.
|
|
|
|
.SH RATIONALE
|
|
|
|
.LP
|
|
|
|
None.
|
|
|
|
.SH FUTURE DIRECTIONS
|
|
|
|
.LP
|
|
|
|
None.
|
|
|
|
.SH SEE ALSO
|
|
|
|
.LP
|
2007-09-20 06:11:55 +00:00
|
|
|
\fIposix_spawn\fP(), \fIposix_spawnattr_destroy\fP(), \fIposix_spawnattr_init\fP()
|
|
|
|
, \fIposix_spawnattr_getsigdefault\fP(), \fIposix_spawnattr_getflags\fP()
|
|
|
|
, \fIposix_spawnattr_getschedparam\fP(), \fIposix_spawnattr_getschedpolicy\fP()
|
|
|
|
, \fIposix_spawnattr_getsigmask\fP(), \fIposix_spawnattr_setsigdefault\fP()
|
|
|
|
, \fIposix_spawnattr_setflags\fP(), \fIposix_spawnattr_setschedparam\fP()
|
|
|
|
, \fIposix_spawnattr_setschedpolicy\fP(), \fIposix_spawnattr_setsigmask\fP()
|
2007-09-20 06:12:53 +00:00
|
|
|
, \fIposix_spawnp\fP(),
|
2004-11-03 13:51:07 +00:00
|
|
|
the Base Definitions volume of IEEE\ Std\ 1003.1-2001, \fI<spawn.h>\fP
|
|
|
|
.SH COPYRIGHT
|
|
|
|
Portions of this text are reprinted and reproduced in electronic form
|
|
|
|
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
|
|
|
|
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
|
|
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
|
|
|
|
Electrical and Electronics Engineers, Inc and The Open Group. 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.opengroup.org/unix/online.html .
|