diff options
author | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 16:26:05 -0800 |
---|---|---|
committer | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 17:26:38 -0800 |
commit | 9c52e721044e7501c3d4567b36d222dc7326224a (patch) | |
tree | 9011790770130c60a712a6f125ad50d60e07cc74 /doc/man/pam_get_data.3 | |
parent | 9727ff2a3fa0e94a42b34a579027bacf4146d571 (diff) | |
parent | 186ff16e8d12ff15d518000c17f115ccab5275a4 (diff) |
New upstream version 1.0.1
Diffstat (limited to 'doc/man/pam_get_data.3')
-rw-r--r-- | doc/man/pam_get_data.3 | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/man/pam_get_data.3 b/doc/man/pam_get_data.3 new file mode 100644 index 00000000..3364eafe --- /dev/null +++ b/doc/man/pam_get_data.3 @@ -0,0 +1,66 @@ +.\" Title: pam_get_data +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/> +.\" Date: 04/16/2008 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" +.TH "PAM_GET_DATA" "3" "04/16/2008" "Linux-PAM Manual" "Linux-PAM Manual" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +pam_get_data - get module internal data +.SH "SYNOPSIS" +.sp +.ft B +.nf +#include <security/pam_modules\.h> +.fi +.ft +.HP 17 +.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) |