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 November 27, 2023
15.Dt PROG_GET_AUXV 3PROC
16.Os
17.Sh NAME
18.Nm proc_get_auxv
19.Nd get process auxiliary vector
20.Sh LIBRARY
21.Lb libproc
22.Sh SYNOPSIS
23.In libproc.h
24.Ft int
25.Fo proc_get_auxv
26.Fa "pid_t proc"
27.Fa "auxv_t *pauxv"
28.Fa "int naux"
29.Fc
30.Sh DESCRIPTION
31The
32.Fn proc_get_auxv
33function is a convenient way to read the /proc auxv file for the process
34.Fa proc .
35Up to
36.Fa naux
37vectors will be read and written into
38.Fa pauxv .
39.Sh RETURN VALUES
40Upon successful completion, the
41.Fn proc_get_auxv
42function returns the number of auxiliary vectors read into
43.Fa pauxv.
44Otherwise,
45.Sy -1
46is returned to indicate an error occurred.
47.Sh INTERFACE STABILITY
48.Sy Uncommitted
49.Sh MT-LEVEL
50.Sy MT-Safe
51.Sh SEE ALSO
52.Xr libproc 3LIB ,
53.Xr proc 5
54