xref: /illumos-gate/usr/src/man/man3proc/Lstatus.3proc (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
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.\"
1443051d27SRobert Mustacchi.Dd May 11, 2016
1543051d27SRobert Mustacchi.Dt LSTATUS 3PROC
1643051d27SRobert Mustacchi.Os
1743051d27SRobert Mustacchi.Sh NAME
1843051d27SRobert Mustacchi.Nm Lstatus
1943051d27SRobert Mustacchi.Nd obtain thread status structure
2043051d27SRobert Mustacchi.Sh SYNOPSIS
2143051d27SRobert Mustacchi.Lb libproc
2243051d27SRobert Mustacchi.In libproc.h
2343051d27SRobert Mustacchi.Ft "const lwpstatus_t *"
2443051d27SRobert Mustacchi.Fo Pstatus
2543051d27SRobert Mustacchi.Fa "struct ps_lwphandle *L"
2643051d27SRobert Mustacchi.Fc
2743051d27SRobert Mustacchi.Sh DESCRIPTION
2843051d27SRobert MustacchiThe
2943051d27SRobert Mustacchi.Fn Lstatus
3043051d27SRobert Mustacchifunction returns the status information about the thread handle
3143051d27SRobert Mustacchi.Fa L .
3243051d27SRobert MustacchiThe
3343051d27SRobert Mustacchi.Sy lwpstatus_t
3443051d27SRobert Mustacchistructure is defined in
35*bbf21555SRichard Lowe.Xr proc 5
3643051d27SRobert Mustacchiand contains information about the thread including its flags, the size
3743051d27SRobert Mustacchiof its stack, its user and system time, and more.
3843051d27SRobert Mustacchi.Pp
3943051d27SRobert MustacchiThe returned pointer is only valid as long as the thread handle
4043051d27SRobert Mustacchi.Fa L
4172d3dbb9SYuri Pankovis valid.
4272d3dbb9SYuri PankovAfter a call to
43b31ca922SChris Fraire.Xr Lfree 3PROC ,
4443051d27SRobert Mustacchithe returned data pointer is invalid.
4543051d27SRobert Mustacchi.Sh RETURN VALUES
4643051d27SRobert MustacchiUpon successful completion, the
4743051d27SRobert Mustacchi.Fn Lstatus
4843051d27SRobert Mustacchifunction returns a pointer to the status information of the process.
4943051d27SRobert MustacchiIt always succeeds.
5043051d27SRobert Mustacchi.Sh INTERFACE STABILITY
5143051d27SRobert Mustacchi.Sy Uncommitted
5243051d27SRobert Mustacchi.Sh MT-LEVEL
5343051d27SRobert MustacchiSee
5443051d27SRobert Mustacchi.Sy LOCKING
5543051d27SRobert Mustacchiin
5643051d27SRobert Mustacchi.Xr libproc 3LIB .
5743051d27SRobert Mustacchi.Sh SEE ALSO
5843051d27SRobert Mustacchi.Xr libproc 3LIB ,
5943051d27SRobert Mustacchi.Xr Lfree 3PROC ,
60*bbf21555SRichard Lowe.Xr proc 5
61