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">
5 <refentry id='pam_get_user'>
8 <refentrytitle>pam_get_user</refentrytitle>
9 <manvolnum>3</manvolnum>
10 <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
13 <refnamediv id='pam_get_user-name'>
14 <refname>pam_get_user</refname>
21 <!-- body begins here -->
25 <funcsynopsis id="pam_get_user-synopsis">
26 <funcsynopsisinfo>#include <security/pam_modules.h></funcsynopsisinfo>
28 <funcdef>int <function>pam_get_user</function></funcdef>
29 <paramdef>const pam_handle_t *<parameter>pamh</parameter></paramdef>
30 <paramdef>const char **<parameter>user</parameter></paramdef>
31 <paramdef>const char *<parameter>prompt</parameter></paramdef>
38 <refsect1 id="pam_get_user-description">
39 <title>DESCRIPTION</title>
41 The <function>pam_get_user</function> function returns the
42 name of the user specified by
44 <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum>
45 </citerefentry>. If no user was specified it what
46 <function>pam_get_item (pamh, PAM_USER, ... );</function> would
47 have returned. If this is NULL it obtains the username via the
49 <refentrytitle>pam_conv</refentrytitle><manvolnum>3</manvolnum>
50 </citerefentry> mechanism, it prompts the user with the first
51 non-NULL string in the following list:
57 The <emphasis>prompt</emphasis> argument passed to the function.
62 What is returned by pam_get_item (pamh, PAM_USER_PROMPT, ... );
67 The default prompt: "login: "
72 By whatever means the username is obtained, a pointer to it is
73 returned as the contents of <emphasis>*user</emphasis>. Note,
74 this memory should <emphasis remap="B">not</emphasis> be
75 <emphasis>free()</emphasis>'d or <emphasis>modified</emphasis>
79 This function sets the <emphasis>PAM_USER</emphasis> item
82 <refentrytitle>pam_set_item</refentrytitle><manvolnum>3</manvolnum>
85 <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
86 </citerefentry> functions.
90 <refsect1 id="pam_get_user-return_values">
91 <title>RETURN VALUES</title>
94 <term>PAM_SUCCESS</term>
97 User name was successful retrieved.
102 <term>PAM_SYSTEM_ERR</term>
105 A NULL pointer was submitted.
110 <term>PAM_CONV_ERR</term>
113 The conversation method supplied by the
114 application failed to obtain the username.
121 <refsect1 id="pam_get_user-see_also">
122 <title>SEE ALSO</title>
125 <refentrytitle>pam_end</refentrytitle><manvolnum>3</manvolnum>
128 <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum>
131 <refentrytitle>pam_set_item</refentrytitle><manvolnum>3</manvolnum>
134 <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum>