getpgid.3p (2644B)
- '\" et
- .TH GETPGID "3P" 2017 "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
- getpgid
- \(em get the process group ID for a process
- .SH SYNOPSIS
- .LP
- .nf
- #include <unistd.h>
- .P
- pid_t getpgid(pid_t \fIpid\fP);
- .fi
- .SH DESCRIPTION
- The
- \fIgetpgid\fR()
- function shall return the process group ID of the process whose process
- ID is equal to
- .IR pid .
- If
- .IR pid
- is equal to 0,
- \fIgetpgid\fR()
- shall return the process group ID of the calling process.
- .SH "RETURN VALUE"
- Upon successful completion,
- \fIgetpgid\fR()
- shall return a process group ID. Otherwise, it shall return
- (\fBpid_t\fP)\-1 and set
- .IR errno
- to indicate the error.
- .SH ERRORS
- The
- \fIgetpgid\fR()
- function shall fail if:
- .TP
- .BR EPERM
- The process whose process ID is equal to
- .IR pid
- is not in the same session as the calling process, and the
- implementation does not allow access to the process group ID of that
- process from the calling process.
- .TP
- .BR ESRCH
- There is no process with a process ID equal to
- .IR pid .
- .P
- The
- \fIgetpgid\fR()
- function may fail if:
- .TP
- .BR EINVAL
- The value of the
- .IR pid
- argument is invalid.
- .LP
- .IR "The following sections are informative."
- .SH EXAMPLES
- None.
- .SH "APPLICATION USAGE"
- None.
- .SH RATIONALE
- None.
- .SH "FUTURE DIRECTIONS"
- None.
- .SH "SEE ALSO"
- .IR "\fIexec\fR\^",
- .IR "\fIfork\fR\^(\|)",
- .IR "\fIgetpgrp\fR\^(\|)",
- .IR "\fIgetpid\fR\^(\|)",
- .IR "\fIgetsid\fR\^(\|)",
- .IR "\fIsetpgid\fR\^(\|)",
- .IR "\fIsetsid\fR\^(\|)"
- .P
- The Base Definitions volume of POSIX.1\(hy2017,
- .IR "\fB<unistd.h>\fP"
- .\"
- .SH COPYRIGHT
- Portions of this text are reprinted and reproduced in electronic form
- from IEEE Std 1003.1-2017, Standard for Information Technology
- -- Portable Operating System Interface (POSIX), The Open Group Base
- Specifications Issue 7, 2018 Edition,
- Copyright (C) 2018 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 .
- .PP
- 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 .