xref: /illumos-gate/usr/src/man/man3proc/Ppsinfo.3proc (revision 9a2c4685271c2f0cb4b08f4cc1192387e67af3f9)
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 SYNOPSIS
21.Lb libproc
22.In libproc.h
23.Ft "const psinfo_t *"
24.Fo Ppsinfo
25.Fa "struct ps_prochandle *P"
26.Fc
27.Sh DESCRIPTION
28The
29.Fn Ppsinfo
30function returns the process handle
31.Fa P Ns 's
32.Xr ps 1
33information. The
34.Sy psinfo_t
35structure that is returned is defined in
36.Xr proc 4
37and is valid until a subsequent call to
38.Xr Prelease 3PROC .
39.Sh RETURN VALUES
40Upon successful completion, the
41.Fn Ppsinfo
42function returns a pointer to the process ps information. Otherwise,
43.Dv NULL
44is returned to indicate that it could not be found.
45.Sh INTERFACE STABILITY
46.Sy Uncommitted
47.Sh MT-LEVEL
48See
49.Sy LOCKING
50in
51.Xr libproc 3LIB .
52.Sh SEE ALSO
53.Xr ps 1 ,
54.Xr libproc 3LIB ,
55.Xr Prelease 3PROC ,
56.Xr proc 4
57