.\"
.\" This file and its contents are supplied under the terms of the
.\" Common Development and Distribution License ("CDDL"), version 1.0.
.\" You may only use this file in accordance with the terms of version
.\" 1.0 of the CDDL.
.\"
.\" A full copy of the text of the CDDL should have accompanied this
.\" source.  A copy of the CDDL is also available via the Internet at
.\" http://www.illumos.org/license/CDDL.
.\"
.\"
.\" Copyright 2015 Joyent, Inc.
.\"
.Dd November 8, 2020
.Dt PROC_GET_STATUS 3PROC
.Os
.Sh NAME
.Nm proc_get_status
.Nd get process status information
.Sh SYNOPSIS
.Lb libproc
.In libproc.h
.Ft int
.Fo proc_get_status
.Fa "pid_t pid"
.Fa "pstatus_t *psp"
.Fc
.Sh DESCRIPTION
The
.Fn proc_get_status
function is a convenient way to read the /proc status file for the
process
.Fa pid .
The status information of the process will be filled into
.Fa psp .
The definition of the
.Sy pstatus_t
structure may be found in
.Xr proc 5 .
.Sh RETURN VALUES
Upon successful completion, the
.Fn proc_get_status
function returns
.Sy 0 .
Otherwise,
.Sy -1
is returned to indicate an error occurred.
.Sh INTERFACE STABILITY
.Sy Uncommitted
.Sh MT-LEVEL
.Sy MT-Safe
.Sh SEE ALSO
.Xr libproc 3LIB ,
.Xr proc 5