xref: /illumos-gate/usr/src/man/man3proc/Lstatus.3proc (revision 43f863f959a7ec8a6ee3645d33997561ff808c39)
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 LSTATUS 3PROC
16.Os
17.Sh NAME
18.Nm Lstatus
19.Nd obtain thread status structure
20.Sh SYNOPSIS
21.Lb libproc
22.In libproc.h
23.Ft "const lwpstatus_t *"
24.Fo Pstatus
25.Fa "struct ps_lwphandle *L"
26.Fc
27.Sh DESCRIPTION
28The
29.Fn Lstatus
30function returns the status information about the thread handle
31.Fa L .
32The
33.Sy lwpstatus_t
34structure is defined in
35.Xr proc 5
36and contains information about the thread including its flags, the size
37of its stack, its user and system time, and more.
38.Pp
39The returned pointer is only valid as long as the thread handle
40.Fa L
41is valid.
42After a call to
43.Xr Lfree 3PROC ,
44the returned data pointer is invalid.
45.Sh RETURN VALUES
46Upon successful completion, the
47.Fn Lstatus
48function returns a pointer to the status information of the process.
49It always succeeds.
50.Sh INTERFACE STABILITY
51.Sy Uncommitted
52.Sh MT-LEVEL
53See
54.Sy LOCKING
55in
56.Xr libproc 3LIB .
57.Sh SEE ALSO
58.Xr libproc 3LIB ,
59.Xr Lfree 3PROC ,
60.Xr proc 5
61