doc/man/pam_strerror.3.xml


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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="pam_strerror">

  <refmeta>
    <refentrytitle>pam_strerror</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo class="source">Linux-PAM</refmiscinfo>
    <refmiscinfo class="manual">Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv xml:id="pam_strerror-name">
    <refname>pam_strerror</refname>
    <refpurpose>return string describing PAM error code</refpurpose>
  </refnamediv>

<!-- body begins here -->

  <refsynopsisdiv>
    <funcsynopsis xml:id="pam_strerror-synopsis">
      <funcsynopsisinfo>#include &lt;security/pam_appl.h&gt;</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 xml: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 xml:id="pam_strerror-return_values">
    <title>RETURN VALUES</title>
    <para>
       This function returns always a pointer to a string.
    </para>
  </refsect1>

  <refsect1 xml:id="pam_strerror-see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>
</refentry>