diff options
| author | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 13:00:10 -0800 |
|---|---|---|
| committer | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 13:00:10 -0800 |
| commit | 9d69c7bbb05cc22edce56e751cef5828e652988a (patch) | |
| tree | b97c4aa6e6133fa3e319805c5190819020838c32 /Linux-PAM/doc/man/pam_strerror.3.xml | |
| parent | a6f4ab0bebc76acf85cc0244bd21c1036009c28c (diff) | |
| parent | d5b06b67bbeeed7c05c0eb2e05d6a972ad050d1c (diff) | |
| download | pam-9d69c7bbb05cc22edce56e751cef5828e652988a.tar.gz pam-9d69c7bbb05cc22edce56e751cef5828e652988a.tar.bz2 pam-9d69c7bbb05cc22edce56e751cef5828e652988a.zip | |
Merge tag 'upstream/0.99.7.1' into debian
Diffstat (limited to 'Linux-PAM/doc/man/pam_strerror.3.xml')
| -rw-r--r-- | Linux-PAM/doc/man/pam_strerror.3.xml | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/Linux-PAM/doc/man/pam_strerror.3.xml b/Linux-PAM/doc/man/pam_strerror.3.xml new file mode 100644 index 00000000..954e131d --- /dev/null +++ b/Linux-PAM/doc/man/pam_strerror.3.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> + +<refentry id='pam_strerror'> + + <refmeta> + <refentrytitle>pam_strerror</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_strerror-name"> + <refname>pam_strerror</refname> + <refpurpose>return string describing PAM error code</refpurpose> + </refnamediv> + +<!-- body begins here --> + + <refsynopsisdiv> + <funcsynopsis id="pam_strerror-synopsis"> + <funcsynopsisinfo>#include <security/pam_appl.h></funcsynopsisinfo> + <funcprototype> + <funcdef>const char *<function>pam_strerror</function></funcdef> + <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef> + <paramdef>int <parameter>errnum</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + + <refsect1 id="pam_strerror-description"> + <title>DESCRIPTION</title> + <para> + The <function>pam_strerror</function> function returns a pointer to + a string describing the error code passed in the argument + <emphasis>errnum</emphasis>, 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. + </para> + </refsect1> + <refsect1 id="pam_strerror-return_values"> + <title>RETURN VALUES</title> + <para> + This function returns always a pointer to a string. + </para> + </refsect1> + + <refsect1 id="pam_strerror-see_also"> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry> |