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