summaryrefslogtreecommitdiff
path: root/usr/src/man/man2/getpid.2
blob: 35f91af4aa2c3f83ca092d67fbf12e667cc72e3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
'\" te
.\" Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved.
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
.\" 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/.
.\" 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.
.\"  This notice shall appear on any product containing this material.
.\" 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.
.\" 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.
.\" 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]
.TH getpid 2 "27 Jan 2009" "SunOS 5.11" "System Calls"
.SH NAME
getpid, getpgrp, getppid, getpgid \- get process, process group, and parent
process IDs
.SH SYNOPSIS
.LP
.nf
#include <unistd.h>

\fBpid_t\fR \fBgetpid\fR(\fBvoid\fR);
.fi

.LP
.nf
\fBpid_t\fR \fBgetpgrp\fR(\fBvoid\fR);
.fi

.LP
.nf
\fBpid_t\fR \fBgetppid\fR(\fBvoid\fR);
.fi

.LP
.nf
\fBpid_t\fR \fBgetpgid\fR(\fBpid_t\fR \fIpid\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBgetpid()\fR function returns the process \fBID\fR of the calling
process.
.sp
.LP
The \fBgetpgrp()\fR function returns the process group \fBID\fR of the calling
process.
.sp
.LP
The \fBgetppid()\fR function returns the parent process \fBID\fR of the calling
process.
.sp
.LP
The \fBgetpgid()\fR function returns the process group \fBID\fR of the process
whose process \fBID\fR is equal to \fIpid,\fR or the process group \fBID\fR of
the calling process, if \fIpid\fR is equal to 0.
.SH RETURN VALUES
.sp
.LP
The \fBgetpid()\fR, \fBgetpgrp()\fR, and \fBgetppid()\fR functions are always
successful and no return value is reserved to indicate an error.
.sp
.LP
Upon successful completion, \fBgetpgid()\fR returns the process group ID.
Otherwise, \fBgetpgid()\fR returns \fB(pid_t)\(mi1\fR and sets \fBerrno\fR to
indicate the error.
.SH ERRORS
.sp
.LP
The \fBgetpgid()\fR function will fail if:
.sp
.ne 2
.mk
.na
\fB\fBEPERM\fR\fR
.ad
.RS 9n
.rt  
The process whose process  \fBID\fR is equal to \fIpid\fR is not in the same
session as the calling process, and the implementation does not allow access to
the process group \fBID\fR of that process from the calling process.
.RE

.sp
.ne 2
.mk
.na
\fB\fBESRCH\fR\fR
.ad
.RS 9n
.rt  
There is no process with a process \fBID\fR equal to \fIpid\fR.
.RE

.sp
.LP
The \fBgetpgid()\fR function may fail if:
.sp
.ne 2
.mk
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
.rt  
The value of the \fIpid\fR argument is invalid.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelAsync-Signal-Safe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBIntro\fR(2), \fBexec\fR(2), \fBfork\fR(2), \fBgetsid\fR(2),
\fBsetpgid\fR(2), \fBsetpgrp\fR(2), \fBsetsid\fR(2), \fBsignal\fR(3C),
\fBattributes\fR(5), \fBstandards\fR(5)