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