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