| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182 |
- '\" t
- .\" Title: pam_get_data
- .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
- .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
- .\" Date: 09/03/2021
- .\" Manual: Linux-PAM Manual
- .\" Source: Linux-PAM Manual
- .\" Language: English
- .\"
- .TH "PAM_GET_DATA" "3" "09/03/2021" "Linux-PAM Manual" "Linux-PAM Manual"
- .\" -----------------------------------------------------------------
- .\" * Define some portability stuff
- .\" -----------------------------------------------------------------
- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- .\" http://bugs.debian.org/507673
- .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- .ie \n(.g .ds Aq \(aq
- .el .ds Aq '
- .\" -----------------------------------------------------------------
- .\" * set default formatting
- .\" -----------------------------------------------------------------
- .\" disable hyphenation
- .nh
- .\" disable justification (adjust text to left margin only)
- .ad l
- .\" -----------------------------------------------------------------
- .\" * MAIN CONTENT STARTS HERE *
- .\" -----------------------------------------------------------------
- .SH "NAME"
- pam_get_data \- get module internal data
- .SH "SYNOPSIS"
- .sp
- .ft B
- .nf
- #include <security/pam_modules\&.h>
- .fi
- .ft
- .HP \w'int\ pam_get_data('u
- .BI "int pam_get_data(const\ pam_handle_t\ *" "pamh" ", const\ char\ *" "module_data_name" ", const\ void\ **" "data" ");"
- .SH "DESCRIPTION"
- .PP
- This function together with the
- \fBpam_set_data\fR(3)
- function is useful to manage module\-specific data meaningful only to the calling PAM module\&.
- .PP
- The
- \fBpam_get_data\fR
- function looks up the object associated with the (hopefully) unique string
- \fImodule_data_name\fR
- in the PAM context specified by the
- \fIpamh\fR
- argument\&. A successful call to
- \fBpam_get_data\fR
- will result in
- \fIdata\fR
- pointing to the object\&. Note, this data is
- \fInot\fR
- a copy and should be treated as
- \fIconstant\fR
- by the module\&.
- .SH "RETURN VALUES"
- .PP
- PAM_SUCCESS
- .RS 4
- Data was successful retrieved\&.
- .RE
- .PP
- PAM_SYSTEM_ERR
- .RS 4
- A NULL pointer was submitted as PAM handle or the function was called by an application\&.
- .RE
- .PP
- PAM_NO_MODULE_DATA
- .RS 4
- Module data not found or there is an entry, but it has the value NULL\&.
- .RE
- .SH "SEE ALSO"
- .PP
- \fBpam_end\fR(3),
- \fBpam_set_data\fR(3),
- \fBpam_strerror\fR(3)
|
