xref: /illumos-gate/usr/src/man/man3proc/Lstatus.3proc (revision 43051d2742bbe5911de73322064cb573b6aff975)
1*43051d27SRobert Mustacchi.\"
2*43051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*43051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*43051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*43051d27SRobert Mustacchi.\" 1.0 of the CDDL.
6*43051d27SRobert Mustacchi.\"
7*43051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*43051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*43051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*43051d27SRobert Mustacchi.\"
11*43051d27SRobert Mustacchi.\"
12*43051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
13*43051d27SRobert Mustacchi.\"
14*43051d27SRobert Mustacchi.Dd May 11, 2016
15*43051d27SRobert Mustacchi.Dt LSTATUS 3PROC
16*43051d27SRobert Mustacchi.Os
17*43051d27SRobert Mustacchi.Sh NAME
18*43051d27SRobert Mustacchi.Nm Lstatus
19*43051d27SRobert Mustacchi.Nd obtain thread status structure
20*43051d27SRobert Mustacchi.Sh SYNOPSIS
21*43051d27SRobert Mustacchi.Lb libproc
22*43051d27SRobert Mustacchi.In libproc.h
23*43051d27SRobert Mustacchi.Ft "const lwpstatus_t *"
24*43051d27SRobert Mustacchi.Fo Pstatus
25*43051d27SRobert Mustacchi.Fa "struct ps_lwphandle *L"
26*43051d27SRobert Mustacchi.Fc
27*43051d27SRobert Mustacchi.Sh DESCRIPTION
28*43051d27SRobert MustacchiThe
29*43051d27SRobert Mustacchi.Fn Lstatus
30*43051d27SRobert Mustacchifunction returns the status information about the thread handle
31*43051d27SRobert Mustacchi.Fa L .
32*43051d27SRobert MustacchiThe
33*43051d27SRobert Mustacchi.Sy lwpstatus_t
34*43051d27SRobert Mustacchistructure is defined in
35*43051d27SRobert Mustacchi.Xr proc 4
36*43051d27SRobert Mustacchiand contains information about the thread including its flags, the size
37*43051d27SRobert Mustacchiof its stack, its user and system time, and more.
38*43051d27SRobert Mustacchi.Pp
39*43051d27SRobert MustacchiThe returned pointer is only valid as long as the thread handle
40*43051d27SRobert Mustacchi.Fa L
41*43051d27SRobert Mustacchiis valid. After a call to
42*43051d27SRobert Mustacchi.Xr Ltree 3PROC ,
43*43051d27SRobert Mustacchithe returned data pointer is invalid.
44*43051d27SRobert Mustacchi.Sh RETURN VALUES
45*43051d27SRobert MustacchiUpon successful completion, the
46*43051d27SRobert Mustacchi.Fn Lstatus
47*43051d27SRobert Mustacchifunction returns a pointer to the status information of the process.
48*43051d27SRobert MustacchiIt always succeeds.
49*43051d27SRobert Mustacchi.Sh INTERFACE STABILITY
50*43051d27SRobert Mustacchi.Sy Uncommitted
51*43051d27SRobert Mustacchi.Sh MT-LEVEL
52*43051d27SRobert MustacchiSee
53*43051d27SRobert Mustacchi.Sy LOCKING
54*43051d27SRobert Mustacchiin
55*43051d27SRobert Mustacchi.Xr libproc 3LIB .
56*43051d27SRobert Mustacchi.Sh SEE ALSO
57*43051d27SRobert Mustacchi.Xr libproc 3LIB ,
58*43051d27SRobert Mustacchi.Xr Lfree 3PROC ,
59*43051d27SRobert Mustacchi.Xr proc 4
60