Content-type: text/html Man page of tcgetpgrp

tcgetpgrp

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

tcgetpgrp - Gets foreground process group ID  

LIBRARY

Standard C Library (libc.so, libc.a)  

SYNOPSIS

#include <unistd.h>

pid_t tcgetpgrp(
        int filedes);

Application developers may want to specify an #include statement for <sys/types.h> before the one for <unistd.h> if programs are being developed for multiple platforms. The additional #include statement is not required on Tru64 UNIX systems or by ISO or X/Open standards, but may be required on other vendors' systems that conform to these standards.  

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

tcgetpgrp():  XPG4, XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.  

PARAMETERS

Indicates the open file descriptor for the terminal special file.  

DESCRIPTION

The tcgetpgrp() function returns the value of the process group ID of the foreground process group associated with the terminal. The function can be called from a background process; however, the information may be subsequently changed by the foreground process.  

RETURN VALUES

Upon successful completion, the process group ID of the foreground process is returned. Otherwise, a value of -1 is returned and errno is set to indicate the error.  

ERRORS

The tcgetpgrp() function sets errno to the specified values for the following conditions: The filedes parameter is not a valid file descriptor. The calling process does not have a controlling terminal or the file is not the controlling terminal.  

RELATED INFORMATION

Functions: setpgid(2), setsid(2), tcsetpgrp(3)

Standards: standards(5) delim off


 

Index

NAME
LIBRARY
SYNOPSIS
STANDARDS
PARAMETERS
DESCRIPTION
RETURN VALUES
ERRORS
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:41:48 GMT, October 02, 2010