xref: /illumos-gate/usr/src/man/man3proc/Ppsinfo.3proc (revision eb9a1df2aeb866bf1de4494433b6d7e5fa07b3ae)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2015 Joyent, Inc.
13.\"
14.Dd May 11, 2016
15.Dt PPSINFO 3PROC
16.Os
17.Sh NAME
18.Nm Ppsinfo
19.Nd get process ps information
20.Sh LIBRARY
21.Lb libproc
22.Sh SYNOPSIS
23.In libproc.h
24.Ft "const psinfo_t *"
25.Fo Ppsinfo
26.Fa "struct ps_prochandle *P"
27.Fc
28.Sh DESCRIPTION
29The
30.Fn Ppsinfo
31function returns the process handle
32.Fa P Ns 's
33.Xr ps 1
34information.
35The
36.Sy psinfo_t
37structure that is returned is defined in
38.Xr proc 4
39and is valid until a subsequent call to
40.Xr Prelease 3PROC .
41.Sh RETURN VALUES
42Upon successful completion, the
43.Fn Ppsinfo
44function returns a pointer to the process ps information.
45Otherwise,
46.Dv NULL
47is returned to indicate that it could not be found.
48.Sh INTERFACE STABILITY
49.Sy Uncommitted
50.Sh MT-LEVEL
51See
52.Sy LOCKING
53in
54.Xr libproc 3LIB .
55.Sh SEE ALSO
56.Xr ps 1 ,
57.Xr libproc 3LIB ,
58.Xr Prelease 3PROC ,
59.Xr proc 4
60