usr/src/man/man3proc/Pgetenv.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 PGETENV 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Pgetenv
  19 .Nd get process environment variable
  20 .Sh LIBRARY
  21 .Lb libproc
  22 .Sh SYNOPSIS
  23 .In libproc.h
  24 .Ft "char *"
  25 .Fo Pgetenv
  26 .Fa "struct ps_prochandle *P"
  27 .Fa "const char *name"
  28 .Fa "char *buf"
  29 .Fa "size_t buflen"
  30 .Fc
  31 .Sh DESCRIPTION
  32 The
  33 .Fa Pgetenv
  34 function searches the environment of the process handle
  35 .Fa P
  36 for the environment variable named
  37 .Fa name .
  38 If found it copies up to
  39 .Fa buflen
  40 characters of the value, including the null terminator, into the buffer
  41 .Fa buf .
  42 Everything after the
  43 .Sy =
  44 sign is copied.
  45 .Sh RETURN VALUES
  46 Upon successful completion, the
  47 .Fn Pgetenv
  48 function returns the pointer
  49 .Fa buf .
  50 Otherwise, if the environment variable was not found,
  51 .Dv NULL
  52 is returned.
  53 .Sh INTERFACE STABILITY
  54 .Sy Uncommitted
  55 .Sh MT-LEVEL
  56 See
  57 .Sy LOCKING
  58 in
  59 .Xr libproc 3LIB .
  60 .Sh SEE ALSO
  61 .Xr libproc 3LIB ,
  62 .Xr Penv_iter 3PROC ,
  63 .Xr environ 5