tcsetpgrp(3)

tcsetpgrp3

Set foreground process group id

Usage

#include <unistd.h>

int

tcsetpgrp(int fildes, pid_t pgid_id);

Library

Standard C Library (libc, -lc)

Overview

If the process has a controlling terminal, the tcsetpgrp() function sets the foreground process group ID associated with the terminal device to pgid_id. The terminal device associated with fildes must be the controlling terminal of the calling process and the controlling terminal must be currently associated with the session of the calling process. The value of pgid_id must be the same as the process group ID of a process in the same session as the calling process.

Return values

The tcsetpgrp() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

Errors

The tcsetpgrp() function will fail if:

[EBADF]

The fildes argument is not a valid file descriptor.

[EINVAL]

An invalid value of pgid_id was specified.

[ENOTTY]

The calling process does not have a controlling terminal, or the file represented by fildes is not the controlling terminal, or the controlling terminal is no longer associated with the session of the calling process.

[EPERM]

The pgid_id argument does not match the process group ID of a process in the same session as the calling process.

Legacy synopsis

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

The include file ⟨sys/types.h⟩ is necessary.

Releases

163 releases since Mac OS X 10.0; the text changed 2 times.

  1. 10.0–10.1.5
  2. 10.2–10.4.11
  3. 10.5–26.5

Standards

The tcsetpgrp() function is expected to be compliant with the IEEE Std 1003.1-1988 (“POSIX.1”) specification.

From Libc 1752.120.2 in macOS 26.5. Parsed by carta from the page's mdoc source.