xref: /illumos-gate/usr/src/man/man3proc/proc_get_status.3proc (revision a7d7cafedfa26f9e421bbcaf42b7387ef67c0a31)
143051d27SRobert Mustacchi.\"
243051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
343051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
443051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
543051d27SRobert Mustacchi.\" 1.0 of the CDDL.
643051d27SRobert Mustacchi.\"
743051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
843051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
943051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
1043051d27SRobert Mustacchi.\"
1143051d27SRobert Mustacchi.\"
1243051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
1343051d27SRobert Mustacchi.\"
14*a7d7cafeSRobert Mustacchi.Dd November 27, 2023
1543051d27SRobert Mustacchi.Dt PROC_GET_STATUS 3PROC
1643051d27SRobert Mustacchi.Os
1743051d27SRobert Mustacchi.Sh NAME
18c72d9262SPeter Tribble.Nm proc_get_status
1943051d27SRobert Mustacchi.Nd get process status information
20*a7d7cafeSRobert Mustacchi.Sh LIBRARY
2143051d27SRobert Mustacchi.Lb libproc
22*a7d7cafeSRobert Mustacchi.Sh SYNOPSIS
2343051d27SRobert Mustacchi.In libproc.h
2443051d27SRobert Mustacchi.Ft int
25c72d9262SPeter Tribble.Fo proc_get_status
2643051d27SRobert Mustacchi.Fa "pid_t pid"
2743051d27SRobert Mustacchi.Fa "pstatus_t *psp"
2843051d27SRobert Mustacchi.Fc
2943051d27SRobert Mustacchi.Sh DESCRIPTION
3043051d27SRobert MustacchiThe
31c72d9262SPeter Tribble.Fn proc_get_status
3243051d27SRobert Mustacchifunction is a convenient way to read the /proc status file for the
3343051d27SRobert Mustacchiprocess
3443051d27SRobert Mustacchi.Fa pid .
3543051d27SRobert MustacchiThe status information of the process will be filled into
3643051d27SRobert Mustacchi.Fa psp .
3743051d27SRobert MustacchiThe definition of the
3843051d27SRobert Mustacchi.Sy pstatus_t
3943051d27SRobert Mustacchistructure may be found in
40bbf21555SRichard Lowe.Xr proc 5 .
4143051d27SRobert Mustacchi.Sh RETURN VALUES
4243051d27SRobert MustacchiUpon successful completion, the
43c72d9262SPeter Tribble.Fn proc_get_status
4443051d27SRobert Mustacchifunction returns
4543051d27SRobert Mustacchi.Sy 0 .
4643051d27SRobert MustacchiOtherwise,
4743051d27SRobert Mustacchi.Sy -1
4843051d27SRobert Mustacchiis returned to indicate an error occurred.
4943051d27SRobert Mustacchi.Sh INTERFACE STABILITY
5043051d27SRobert Mustacchi.Sy Uncommitted
5143051d27SRobert Mustacchi.Sh MT-LEVEL
5243051d27SRobert Mustacchi.Sy MT-Safe
5343051d27SRobert Mustacchi.Sh SEE ALSO
5443051d27SRobert Mustacchi.Xr libproc 3LIB ,
55bbf21555SRichard Lowe.Xr proc 5
56