Debian Codegraph @

upstream/debian-unstable/man3/pam_get_data.3

raw
1 '\" t
2 .\" Title: pam_get_data
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_GET_DATA" "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_get_data \- get module internal data
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <security/pam_modules\&.h>
37 .fi
38 .ft
39 .HP \w'int\ pam_get_data('u
40 .BI "int pam_get_data(const\ pam_handle_t\ *" "pamh" ", const\ char\ *" "module_data_name" ", const\ void\ **" "data" ");"
41 .SH "DESCRIPTION"
42 .PP
43 This function together with the
44 \fBpam_set_data\fR(3)
45 function is useful to manage module\-specific data meaningful only to the calling PAM module\&.
46 .PP
47 The
48 \fBpam_get_data\fR
49 function looks up the object associated with the (hopefully) unique string
50 \fImodule_data_name\fR
51 in the PAM context specified by the
52 \fIpamh\fR
53 argument\&. A successful call to
54 \fBpam_get_data\fR
55 will result in
56 \fIdata\fR
57 pointing to the object\&. Note, this data is
58 \fInot\fR
59 a copy and should be treated as
60 \fIconstant\fR
61 by the module\&.
62 .SH "RETURN VALUES"
63 .PP
64 PAM_SUCCESS
65 .RS 4
66 Data was successful retrieved\&.
67 .RE
68 .PP
69 PAM_SYSTEM_ERR
70 .RS 4
71 A NULL pointer was submitted as PAM handle or the function was called by an application\&.
72 .RE
73 .PP
74 PAM_NO_MODULE_DATA
75 .RS 4
76 No module specific data is present\&.
77 .RE
78 .SH "SEE ALSO"
79 .PP
80 \fBpam_end\fR(3),
81 \fBpam_set_data\fR(3),
82 \fBpam_strerror\fR(3)