share/man/man2/getpid.2

   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 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  45 .\" Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH GETPID 2 "Jan 27, 2009"
  48 .SH NAME
  49 getpid, getpgrp, getppid, getpgid \- get process, process group, and parent
  50 process IDs
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 #include <unistd.h>
  55
  56 \fBpid_t\fR \fBgetpid\fR(\fBvoid\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBpid_t\fR \fBgetpgrp\fR(\fBvoid\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBpid_t\fR \fBgetppid\fR(\fBvoid\fR);
  67 .fi
  68
  69 .LP
  70 .nf
  71 \fBpid_t\fR \fBgetpgid\fR(\fBpid_t\fR \fIpid\fR);
  72 .fi
  73
  74 .SH DESCRIPTION
  75 .sp
  76 .LP
  77 The \fBgetpid()\fR function returns the process \fBID\fR of the calling
  78 process.
  79 .sp
  80 .LP
  81 The \fBgetpgrp()\fR function returns the process group \fBID\fR of the calling
  82 process.
  83 .sp
  84 .LP
  85 The \fBgetppid()\fR function returns the parent process \fBID\fR of the calling
  86 process.
  87 .sp
  88 .LP
  89 The \fBgetpgid()\fR function returns the process group \fBID\fR of the process
  90 whose process \fBID\fR is equal to \fIpid,\fR or the process group \fBID\fR of
  91 the calling process, if \fIpid\fR is equal to 0.
  92 .SH RETURN VALUES
  93 .sp
  94 .LP
  95 The \fBgetpid()\fR, \fBgetpgrp()\fR, and \fBgetppid()\fR functions are always
  96 successful and no return value is reserved to indicate an error.
  97 .sp
  98 .LP
  99 Upon successful completion, \fBgetpgid()\fR returns the process group ID.
 100 Otherwise, \fBgetpgid()\fR returns \fB(pid_t)\(mi1\fR and sets \fBerrno\fR to
 101 indicate the error.
 102 .SH ERRORS
 103 .sp
 104 .LP
 105 The \fBgetpgid()\fR function will fail if:
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBEPERM\fR\fR
 110 .ad
 111 .RS 9n
 112 The process whose process  \fBID\fR is equal to \fIpid\fR is not in the same
 113 session as the calling process, and the implementation does not allow access to
 114 the process group \fBID\fR of that process from the calling process.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fBESRCH\fR\fR
 121 .ad
 122 .RS 9n
 123 There is no process with a process \fBID\fR equal to \fIpid\fR.
 124 .RE
 125
 126 .sp
 127 .LP
 128 The \fBgetpgid()\fR function may fail if:
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBEINVAL\fR\fR
 133 .ad
 134 .RS 10n
 135 The value of the \fIpid\fR argument is invalid.
 136 .RE
 137
 138 .SH ATTRIBUTES
 139 .sp
 140 .LP
 141 See \fBattributes\fR(5) for descriptions of the following attributes:
 142 .sp
 143
 144 .sp
 145 .TS
 146 box;
 147 c | c
 148 l | l .
 149 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 150 _
 151 Interface Stability     Committed
 152 _
 153 MT-Level        Async-Signal-Safe
 154 _
 155 Standard        See \fBstandards\fR(5).
 156 .TE
 157
 158 .SH SEE ALSO
 159 .sp
 160 .LP
 161 \fBIntro\fR(2), \fBexec\fR(2), \fBfork\fR(2), \fBgetsid\fR(2),
 162 \fBsetpgid\fR(2), \fBsetpgrp\fR(2), \fBsetsid\fR(2), \fBsignal\fR(3C),
 163 \fBattributes\fR(5), \fBstandards\fR(5)