share/man/man3proc/Lpsinfo.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 LPSINFO 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Lpsinfo
  19 .Nd get process ps information
  20 .Sh SYNOPSIS
  21 .Lb libproc
  22 .In libproc.h
  23 .Ft "const lwpsinfo_t *"
  24 .Fo Lpsinfo
  25 .Fa "struct ps_lwphandle *L"
  26 .Fc
  27 .Sh DESCRIPTION
  28 The
  29 .Fn Lpsinfo
  30 function returns the thread handle
  31 .Fa L Ns 's
  32 .Xr ps 1
  33 information.
  34 The
  35 .Sy lwpsinfo_t
  36 structure that is returned is defined in
  37 .Xr proc 4
  38 and is valid until a subsequent call to
  39 .Xr Lfree 3PROC .
  40 .Sh RETURN VALUES
  41 Upon successful completion, the
  42 .Fn Lpsinfo
  43 function returns a pointer to the thread's ps information.
  44 Otherwise,
  45 .Dv NULL
  46 is returned to indicate that it could not be found.
  47 .Sh INTERFACE STABILITY
  48 .Sy Uncommitted
  49 .Sh MT-LEVEL
  50 See
  51 .Sy LOCKING
  52 in
  53 .Xr libproc 3LIB .
  54 .Sh SEE ALSO
  55 .Xr ps 1 ,
  56 .Xr libproc 3LIB ,
  57 .Xr Lfree 3PROC ,
  58 .Xr proc 4