summaryrefslogtreecommitdiff
path: root/doc/man/pam_strerror.3
blob: 1a096bafea66d7b9e261933ac976a26d8b58b8c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.\" ** You probably do not want to edit this file directly **
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
.TH "PAM_STRERROR" "3" "02/08/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
pam_strerror \- return string describing PAM error code
.SH "SYNOPSIS"
.PP
\fB#include <security/pam_appl.h>\fR
.HP 25
\fBconst\ char\ *\fBpam_strerror\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBint\ \fR\fB\fIerrnum\fR\fR\fB);\fR
.SH "DESCRIPTION"
.PP
The
\fBpam_strerror\fR
function returns a pointer to a string describing the error code passed in the argument
\fIerrnum\fR, possibly using the LC_MESSAGES part of the current locale to select the appropriate language. This string must not be modified by the application. No library function will modify this string.
.SH "RETURN VALUES"
.PP
This function returns always a pointer to a string.
.SH "SEE ALSO"
.PP
\fBpam\fR(8)