usr/src/man/man3proc/Pgetauxval.3proc

   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 PGETAUXVAL 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Pgetauxval
  19 .Nd obtain auxiliary vector value
  20 .Sh SYNOPSIS
  21 .Lb libproc
  22 .In libproc.h
  23 .Ft int
  24 .Fo Pgetauxval
  25 .Fa "struct ps_prochandle *P"
  26 .Fa "int type"
  27 .Fc
  28 .Sh DESCRIPTION
  29 The
  30 .Fn Pgetauxval
  31 function looks up the entry
  32 .Fa type
  33 in the auxiliary vector of the process handle
  34 .Fa P
  35 and returns its value.
  36 The
  37 .Fa type
  38 argument should be the entry of the auxiliary vector.
  39 The list of such types may be found in
  40 .In sys/auxv.h .
  41 .Sh RETURN VALUES
  42 Upon successful completion, the
  43 .Fn Pgetauxval
  44 function returns the value of the auxiliary vector entry
  45 .Fa type .
  46 Otherwise,
  47 .Sy -1
  48 is returned to indicate that either the auxiliary vector or the
  49 .Fa type
  50 entry could not be found.
  51 .Sh INTERFACE STABILITY
  52 .Sy Uncommitted
  53 .Sh MT-LEVEL
  54 See
  55 .Sy LOCKING
  56 in
  57 .Xr libproc 3LIB .
  58 .Sh SEE ALSO
  59 .Xr libproc 3LIB ,
  60 .Xr Pgetauxvec 3PROC ,
  61 .Xr proc 4