usr/src/man/man2/getpid.2

   1 '\" te
   2 .\" Copyright (c) 2009, 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  http://www.opengroup.org/bookstore/.
   6 .\" 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
   7 .\" 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
   8 .\" 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.
   9 .\"  This notice shall appear on any product containing this material.
  10 .\" 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.
  11 .\" 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.
  12 .\" 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]
  13 .TH GETPID 2 "Jan 27, 2009"
  14 .SH NAME
  15 getpid, getpgrp, getppid, getpgid \- get process, process group, and parent
  16 process IDs
  17 .SH SYNOPSIS
  18 .LP
  19 .nf
  20 #include <unistd.h>
  21
  22 \fBpid_t\fR \fBgetpid\fR(\fBvoid\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBpid_t\fR \fBgetpgrp\fR(\fBvoid\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBpid_t\fR \fBgetppid\fR(\fBvoid\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBpid_t\fR \fBgetpgid\fR(\fBpid_t\fR \fIpid\fR);
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBgetpid()\fR function returns the process \fBID\fR of the calling
  44 process.
  45 .sp
  46 .LP
  47 The \fBgetpgrp()\fR function returns the process group \fBID\fR of the calling
  48 process.
  49 .sp
  50 .LP
  51 The \fBgetppid()\fR function returns the parent process \fBID\fR of the calling
  52 process.
  53 .sp
  54 .LP
  55 The \fBgetpgid()\fR function returns the process group \fBID\fR of the process
  56 whose process \fBID\fR is equal to \fIpid,\fR or the process group \fBID\fR of
  57 the calling process, if \fIpid\fR is equal to 0.
  58 .SH RETURN VALUES
  59 .sp
  60 .LP
  61 The \fBgetpid()\fR, \fBgetpgrp()\fR, and \fBgetppid()\fR functions are always
  62 successful and no return value is reserved to indicate an error.
  63 .sp
  64 .LP
  65 Upon successful completion, \fBgetpgid()\fR returns the process group ID.
  66 Otherwise, \fBgetpgid()\fR returns \fB(pid_t)\(mi1\fR and sets \fBerrno\fR to
  67 indicate the error.
  68 .SH ERRORS
  69 .sp
  70 .LP
  71 The \fBgetpgid()\fR function will fail if:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEPERM\fR\fR
  76 .ad
  77 .RS 9n
  78 The process whose process  \fBID\fR is equal to \fIpid\fR is not in the same
  79 session as the calling process, and the implementation does not allow access to
  80 the process group \fBID\fR of that process from the calling process.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBESRCH\fR\fR
  87 .ad
  88 .RS 9n
  89 There is no process with a process \fBID\fR equal to \fIpid\fR.
  90 .RE
  91
  92 .sp
  93 .LP
  94 The \fBgetpgid()\fR function may fail if:
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBEINVAL\fR\fR
  99 .ad
 100 .RS 10n
 101 The value of the \fIpid\fR argument is invalid.
 102 .RE
 103
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109
 110 .sp
 111 .TS
 112 box;
 113 c | c
 114 l | l .
 115 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 116 _
 117 Interface Stability     Committed
 118 _
 119 MT-Level        Async-Signal-Safe
 120 _
 121 Standard        See \fBstandards\fR(5).
 122 .TE
 123
 124 .SH SEE ALSO
 125 .sp
 126 .LP
 127 \fBIntro\fR(2), \fBexec\fR(2), \fBfork\fR(2), \fBgetsid\fR(2),
 128 \fBsetpgid\fR(2), \fBsetpgrp\fR(2), \fBsetsid\fR(2), \fBsignal\fR(3C),
 129 \fBattributes\fR(5), \fBstandards\fR(5)