granicus.if.org Git - linux-pam/blob - doc/man/pam_strerror.3.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id='pam_strerror'>
   6
   7   <refmeta>
   8     <refentrytitle>pam_strerror</refentrytitle>
   9     <manvolnum>3</manvolnum>
  10     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_strerror-name">
  14     <refname>pam_strerror</refname>
  15     <refpurpose>return string describing PAM error code</refpurpose>
  16   </refnamediv>
  17
  18 <!-- body begins here -->
  19
  20   <refsynopsisdiv>
  21     <funcsynopsis id="pam_strerror-synopsis">
  22       <funcsynopsisinfo>#include &lt;security/pam_appl.h&gt;</funcsynopsisinfo>
  23       <funcprototype>
  24         <funcdef>const char *<function>pam_strerror</function></funcdef>
  25         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  26         <paramdef>int <parameter>errnum</parameter></paramdef>
  27       </funcprototype>
  28     </funcsynopsis>
  29   </refsynopsisdiv>
  30
  31
  32   <refsect1 id="pam_strerror-description">
  33     <title>DESCRIPTION</title>
  34     <para>
  35        The <function>pam_strerror</function> function returns a pointer to
  36        a string describing the error code passed in the argument
  37        <emphasis>errnum</emphasis>, possibly using the LC_MESSAGES part of
  38        the current locale to select the appropriate language. This string
  39        must not be modified by the application. No library function will
  40        modify this string.
  41     </para>
  42   </refsect1>
  43   <refsect1 id="pam_strerror-return_values">
  44     <title>RETURN VALUES</title>
  45     <para>
  46        This function returns always a pointer to a string.
  47     </para>
  48   </refsect1>
  49
  50   <refsect1 id="pam_strerror-see_also">
  51     <title>SEE ALSO</title>
  52     <para>
  53       <citerefentry>
  54         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
  55       </citerefentry>
  56     </para>
  57   </refsect1>
  58 </refentry>