usr/src/man/man3proc/Pcontent.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 PCONTENT 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Pconent
  19 .Nd obtain process content types available
  20 .Sh LIBRARY
  21 .Lb libproc
  22 .Sh SYNOPSIS
  23 .In libproc.h
  24 .Ft "core_content_t"
  25 .Fo Pcontent
  26 .Fa "struct ps_prochandle *P"
  27 .Fc
  28 .Sh DESCRIPTION
  29 The
  30 .Fn Pcontent
  31 function describes information available from the process handle
  32 .Fa P .
  33 .Pp
  34 Different types of process handles have different kinds of content
  35 available to them.
  36 For example, handles to active and running processes have more information
  37 available than various core files, as the core file retains a subset of
  38 information available in the running process.
  39 Handles that refer to ELF objects, obtained through
  40 .Xr Pgrab_file 3PROC ,
  41 will not have information such as a stack available.
  42 The content of core files is controlled by
  43 .Xr coreadm 1M .
  44 .Pp
  45 The symbols that may be returned are listed in the
  46 .Sy core_content_t
  47 heading in the
  48 .Sy TYPES
  49 section in
  50 .Xr libproc 3LIB .
  51 .Sh RETURN VALUES
  52 Upon successful completion, the
  53 .Fn Pcontent
  54 function returns the bitwise-inclusive-OR of content types.
  55 Otherwise,
  56 .Dv CC_CONTENT_INVALID
  57 is returned to indicate an error.
  58 .Sh INTERFACE STABILITY
  59 .Sy Uncommitted
  60 .Sh MT-LEVEL
  61 See
  62 .Sy LOCKING
  63 in
  64 .Xr libproc 3LIB .
  65 .Sh SEE ALSO
  66 .Xr libproc 3LIB ,
  67 .Xr Pcreate 3PROC ,
  68 .Xr Pgrab 3PROC ,
  69 .Xr Pgrab_core 3PROC ,
  70 .Xr Pgrab_file 3PROC ,
  71 .Xr proc 4