tcgetpgrp(3p) — Linux manual page

TCGETPGRP(3P)           POSIX Programmer's Manual          TCGETPGRP(3P)

PROLOG         top

       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.

NAME         top

       tcgetpgrp — get the foreground process group ID

SYNOPSIS         top

       #include <unistd.h>

       pid_t tcgetpgrp(int fildes);

DESCRIPTION         top

       The tcgetpgrp() function shall return the value of the process
       group ID of the foreground process group associated with the
       terminal.

       If there is no foreground process group, tcgetpgrp() shall return
       a value greater than 1 that does not match the process group ID
       of any existing process group.

       The tcgetpgrp() function is allowed from a process that is a
       member of a background process group; however, the information
       may be subsequently changed by a process that is a member of a
       foreground process group.

RETURN VALUE         top

       Upon successful completion, tcgetpgrp() shall return the value of
       the process group ID of the foreground process associated with
       the terminal. Otherwise, -1 shall be returned and errno set to
       indicate the error.

ERRORS         top

       The tcgetpgrp() function shall fail if:

       EBADF  The fildes argument is not a valid file descriptor.

       ENOTTY The calling process does not have a controlling terminal,
              or the file is not the controlling terminal.

       The following sections are informative.

EXAMPLES         top

       None.

APPLICATION USAGE         top

       None.

RATIONALE         top

       None.

FUTURE DIRECTIONS         top

       None.

SEE ALSO         top

       setsid(3p), setpgid(3p), tcsetpgrp(3p)

       The Base Definitions volume of POSIX.1‐2017, sys_types.h(0p),
       unistd.h(0p)

COPYRIGHT         top

       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 .

       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 .

IEEE/The Open Group               2017                     TCGETPGRP(3P)

Pages that refer to this page: unistd.h(0p),  tcsetpgrp(3p)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.