share/man/man3proc/Ppriv.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 PPRIV 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Ppriv ,
  19 .Nm Ppriv_free
  20 .Nd get and free process privilege sets
  21 .Sh SYNOPSIS
  22 .Lb libproc
  23 .In libproc.h
  24 .Ft int
  25 .Fo Ppriv
  26 .Fa "struct ps_prochandle *P"
  27 .Fa "prpriv_t **pprv"
  28 .Fc
  29 .Ft void
  30 .Fo Ppriv_free
  31 .Fa "struct ps_prochandle *P"
  32 .Fa "prpriv_t *prv"
  33 .Fc
  34 .Sh DESCRIPTION
  35 The
  36 .Fn Ppriv
  37 function obtains the privilege set of the process handle
  38 .Fa P .
  39 The privilege set, if it exists, will be dynamically allocated and a
  40 pointer to it will be placed in
  41 .Fa pprv .
  42 It must be released with a call to
  43 .Fn Ppriv_free .
  44 The definition of the
  45 .Sy prpriv_t
  46 structure is documented in
  47 .Xr proc 4 .
  48 .Pp
  49 The
  50 .Fn Ppriv_free
  51 function releases the storage in
  52 .Fa prv
  53 that was allocated as a result of calling
  54 .Fn Ppriv .
  55 .Sh RETURN VALUES
  56 Upon successful completion, the
  57 .Fn Ppriv
  58 function returns
  59 .Sy 0
  60 and
  61 .Fa pprv
  62 is updated with a pointer to the allocated privilege set.
  63 Otherwise,
  64 .Sy -1
  65 is returned and
  66 .Fa pprv
  67 is not updated.
  68 .Sh INTERFACE STABILITY
  69 .Sy Uncommitted
  70 .Sh MT-LEVEL
  71 See
  72 .Sy LOCKING
  73 in
  74 .Xr libproc 3LIB .
  75 .Sh SEE ALSO
  76 .Xr libproc 3LIB ,
  77 .Xr proc 4 ,
  78 .Xr privileges 5