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