usr/src/man/man3proc/Pstatus.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 PSTATUS 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Pstatus
  19 .Nd obtain process status structure
  20 .Sh LIBRARY
  21 .Lb libproc
  22 .Sh SYNOPSIS
  23 .In libproc.h
  24 .Ft "const pstatus_t *"
  25 .Fo Pstatus
  26 .Fa "struct ps_prochandle *P"
  27 .Fc
  28 .Sh DESCRIPTION
  29 The
  30 .Fn Pstatus
  31 function returns the status information about the process handle
  32 .Fa P .
  33 The
  34 .Sy pstatus_t
  35 structure is defined in
  36 .Xr proc 4
  37 and contains information about the process including its flags, the
  38 number of threads, the size of the stack, and more.
  39 .Pp
  40 The returned pointer is only valid as long as the process handle
  41 .Fa P
  42 is valid.
  43 After a call to
  44 .Xr Prelease 3PROC ,
  45 the returned data pointer is invalid.
  46 .Sh RETURN VALUES
  47 The
  48 .Fn Pstatus
  49 function always returns a pointer to the process's status.
  50 .Sh INTERFACE STABILITY
  51 .Sy Uncommitted
  52 .Sh MT-LEVEL
  53 See
  54 .Sy LOCKING
  55 in
  56 .Xr libproc 3LIB .
  57 .Sh SEE ALSO
  58 .Xr libproc 3LIB ,
  59 .Xr Prelease 3PROC ,
  60 .Xr proc 4