man pages section 3: Basic Library Functions

Exit Print View

Updated: July 2014
 
 

tcgetpgrp(3C)

Name

tcgetpgrp - get foreground process group ID

Synopsis

#include <sys/types.h>
#include <unistd.h>

pid_t tcgetpgrp(int fildes);

Description

The tcgetpgrp() function will 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() returns 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 Values

Upon successful completion, tcgetpgrp() returns the value of the process group ID of the foreground process associated with the terminal. Otherwise, −1 is returned and errno is set to indicate the error.

Errors

The tcgetpgrp() function will 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.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe, and Async-Signal-Safe
Standard

See Also

setpgid(2), setsid(2), tcsetpgrp(3C), attributes(5), standards(5), termio(7I)