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