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

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