| Robert Mustacchi | 43051d2 | 2016-05-12 09:47:18 -0700 | [diff] [blame] | 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 |
| 28 | The |
| 29 | .Fn Pgetauxvec |
| 30 | function returns a pointer to a copy of the auxiliary vector for the |
| 31 | process handle |
| 32 | .Fa P . |
| 33 | If the process handle does not represent an actively running process or |
| 34 | the auxiliary vector could not be found, then it instead returns an |
| Yuri Pankov | 72d3dbb | 2017-05-29 03:56:19 +0300 | [diff] [blame] | 35 | empty auxiliary vector. |
| 36 | The definitions of the |
| Robert Mustacchi | 43051d2 | 2016-05-12 09:47:18 -0700 | [diff] [blame] | 37 | .Sy auxv_t |
| 38 | may be found in |
| 39 | .In sys/auxv.h . |
| 40 | .Pp |
| 41 | The returned auxiliary vector should not be used across any subsequent |
| 42 | calls to |
| 43 | .Xr libproc 3LIB . |
| 44 | .Sh RETURN VALUES |
| 45 | Upon successful completion, the |
| 46 | .Fn Pgetauxvec |
| 47 | function always returns a pointer to an auxiliary vector. |
| 48 | .Sh INTERFACE STABILITY |
| 49 | .Sy Uncommitted |
| 50 | .Sh MT-LEVEL |
| 51 | See |
| 52 | .Sy LOCKING |
| 53 | in |
| 54 | .Xr libproc 3LIB . |
| 55 | .Sh SEE ALSO |
| 56 | .Xr libproc 3LIB , |
| 57 | .Xr Pgetauxval 3PROC , |
| 58 | .Xr proc 4 |