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



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       tcgetpgrp -- get the foreground process group ID

SSYYNNOOPPSSIISS
       #include <unistd.h>

       pid_t tcgetpgrp(int _f_i_l_d_e_s);

DDEESSCCRRIIPPTTIIOONN
       The _t_c_g_e_t_p_g_r_p() 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, _t_c_g_e_t_p_g_r_p() shall return a
       value greater than 1 that does not match the process group ID of any
       existing process group.

       The _t_c_g_e_t_p_g_r_p() 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.

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

EERRRROORRSS
       The _t_c_g_e_t_p_g_r_p() function shall fail if:

       EEBBAADDFF  The _f_i_l_d_e_s argument is not a valid file descriptor.

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

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _s_e_t_s_i_d(), _s_e_t_p_g_i_d(), _t_c_s_e_t_p_g_r_p()

       The Base Definitions volume of POSIX.1-2017, <<ssyyss__ttyyppeess..hh>>, <<uunniissttdd..hh>>

CCOOPPYYRRIIGGHHTT
       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(3)
