Debian Codegraph @

upstream/debian-unstable/man3/pam_getenv.3

raw
1 '\" t
2 .\" Title: pam_getenv
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_GETENV" "3" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_getenv \- get a PAM environment variable
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <security/pam_appl\&.h>
37 .fi
38 .ft
39 .HP \w'const\ char\ *pam_getenv('u
40 .BI "const char *pam_getenv(pam_handle_t\ *" "pamh" ", const\ char\ *" "name" ");"
41 .SH "DESCRIPTION"
42 .PP
43 The
44 \fBpam_getenv\fR
45 function searches the PAM environment list as associated with the handle
46 \fIpamh\fR
47 for an item that matches the string pointed to by
48 \fIname\fR
49 and returns a pointer to the value of the environment variable\&. The application is not allowed to free the data\&.
50 .SH "RETURN VALUES"
51 .PP
52 The
53 \fBpam_getenv\fR
54 function returns NULL on failure\&.
55 .SH "SEE ALSO"
56 .PP
57 \fBpam_start\fR(3),
58 \fBpam_getenvlist\fR(3),
59 \fBpam_putenv\fR(3),
60 \fBpam\fR(7)