usr/src/man/man3c/tcsetpgrp.3c

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH TCSETPGRP 3C "Aug 14, 2002"
  13 .SH NAME
  14 tcsetpgrp \- set foreground process group ID
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <sys/types.h>
  19 #include <unistd.h>
  20
  21 \fBint\fR \fBtcsetpgrp\fR(\fBint\fR \fIfildes\fR, \fBpid_t\fR \fIpgid_id\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 If the process has a controlling terminal, \fBtcsetpgrp()\fR will set the
  28 foreground process group \fBID\fR associated with the terminal to
  29 \fIpgid_id\fR. The file associated with \fIfildes\fR must be the controlling
  30 terminal of the calling process and the controlling terminal must be currently
  31 associated with the session of the calling process. The value of \fIpgid_id\fR
  32 must match a process group \fBID\fR of a process in the same session as the
  33 calling process.
  34 .SH RETURN VALUES
  35 .sp
  36 .LP
  37 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  38 returned and \fBerrno\fR is set to indicate the error.
  39 .SH ERRORS
  40 .sp
  41 .LP
  42 The \fBtcsetpgrp()\fR function will fail if:
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBEBADF\fR\fR
  47 .ad
  48 .RS 10n
  49 The \fIfildes\fR argument is not a valid file descriptor.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBEINVAL\fR\fR
  56 .ad
  57 .RS 10n
  58 This implementation does not support the value in the \fIpgid_id\fR argument.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBENOTTY\fR\fR
  65 .ad
  66 .RS 10n
  67 The calling process does not have a controlling terminal, or the file is not
  68 the controlling terminal, or the controlling terminal is no longer associated
  69 with the session of the calling process.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEIO\fR\fR
  76 .ad
  77 .RS 10n
  78 The process is not ignoring or holding \fBSIGTTOU\fR and is a member of an
  79 orphaned process group.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBEPERM\fR\fR
  86 .ad
  87 .RS 10n
  88 The value of \fIpgid_id\fR does not match the process group \fBID\fR of a
  89 process in the same session as the calling process.
  90 .RE
  91
  92 .SH ATTRIBUTES
  93 .sp
  94 .LP
  95 See \fBattributes\fR(5) for descriptions of the following attributes:
  96 .sp
  97
  98 .sp
  99 .TS
 100 box;
 101 c | c
 102 l | l .
 103 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 104 _
 105 Interface Stability     Standard
 106 _
 107 MT-Level        MT-Safe, and Async-Signal-Safe
 108 .TE
 109
 110 .SH SEE ALSO
 111 .sp
 112 .LP
 113 \fBtcgetpgrp\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5), \fBtermio\fR(7I)