xref: /illumos-gate/usr/src/man/man3proc/Pgetauxvec.3proc (revision c4140c56306ad2a74081dd949618b4f3162dd06b)
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 PGETAUXVEC 3PROC
16.Os
17.Sh NAME
18.Nm Pgetauxvec
19.Nd obtain process auxiliary vector
20.Sh LIBRARY
21.Lb libproc
22.Sh SYNOPSIS
23.In libproc.h
24.Ft "const auxv_t *"
25.Fo Pgetauxvec
26.Fa "struct ps_prochandle *P"
27.Fc
28.Sh DESCRIPTION
29The
30.Fn Pgetauxvec
31function returns a pointer to a copy of the auxiliary vector for the
32process handle
33.Fa P .
34If the process handle does not represent an actively running process or
35the auxiliary vector could not be found, then it instead returns an
36empty auxiliary vector.
37The definitions of the
38.Sy auxv_t
39may be found in
40.In sys/auxv.h .
41.Pp
42The returned auxiliary vector should not be used across any subsequent
43calls to
44.Xr libproc 3LIB .
45.Sh RETURN VALUES
46Upon successful completion, the
47.Fn Pgetauxvec
48function always returns a pointer to an auxiliary vector.
49.Sh INTERFACE STABILITY
50.Sy Uncommitted
51.Sh MT-LEVEL
52See
53.Sy LOCKING
54in
55.Xr libproc 3LIB .
56.Sh SEE ALSO
57.Xr libproc 3LIB ,
58.Xr Pgetauxval 3PROC ,
59.Xr proc 5
60