usr/src/man/man3proc/Lstatus.3proc

   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
  28 The
  29 .Fn Lstatus
  30 function returns the status information about the thread handle
  31 .Fa L .
  32 The
  33 .Sy lwpstatus_t
  34 structure is defined in
  35 .Xr proc 4
  36 and contains information about the thread including its flags, the size
  37 of its stack, its user and system time, and more.
  38 .Pp
  39 The returned pointer is only valid as long as the thread handle
  40 .Fa L
  41 is valid. After a call to
  42 .Xr Ltree 3PROC ,
  43 the returned data pointer is invalid.
  44 .Sh RETURN VALUES
  45 Upon successful completion, the
  46 .Fn Lstatus
  47 function returns a pointer to the status information of the process.
  48 It always succeeds.
  49 .Sh INTERFACE STABILITY
  50 .Sy Uncommitted
  51 .Sh MT-LEVEL
  52 See
  53 .Sy LOCKING
  54 in
  55 .Xr libproc 3LIB .
  56 .Sh SEE ALSO
  57 .Xr libproc 3LIB ,
  58 .Xr Lfree 3PROC ,
  59 .Xr proc 4