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_prompt">
8 <refentrytitle>pam_prompt</refentrytitle>
9 <manvolnum>3</manvolnum>
10 <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
13 <refnamediv id="pam_prompt-name">
14 <refname>pam_prompt</refname>
15 <refname>pam_vprompt</refname>
16 <refpurpose>interface to conversation function</refpurpose>
19 <!-- body begins here -->
21 <refsynopsisdiv id="pam_prompt-synopsis">
23 <funcsynopsisinfo>#include <security/pam_ext.h></funcsynopsisinfo>
25 <funcdef>void <function>pam_prompt</function></funcdef>
26 <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
27 <paramdef>int <parameter>style</parameter></paramdef>
28 <paramdef>char **<parameter>response</parameter></paramdef>
29 <paramdef>const char *<parameter>fmt</parameter></paramdef>
30 <paramdef><parameter>...</parameter></paramdef>
33 <funcdef>void <function>pam_vprompt</function></funcdef>
34 <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
35 <paramdef>int <parameter>style</parameter></paramdef>
36 <paramdef>char **<parameter>response</parameter></paramdef>
37 <paramdef>const char *<parameter>fmt</parameter></paramdef>
38 <paramdef>va_list <parameter>args</parameter></paramdef>
43 <refsect1 id='pam_prompt-description'>
44 <title>DESCRIPTION</title>
46 The <function>pam_prompt</function> function constructs a message
47 from the specified format string and arguments and passes it to the
48 conversation function as set by the service. Upon successful return,
49 <emphasis>response</emphasis> is set to point to a string
50 returned from the conversation function. This string is allocated
51 on heap and should be freed.
55 <refsect1 id="pam_prompt-return_values">
56 <title>RETURN VALUES</title>
59 <term>PAM_BUF_ERR</term>
67 <term>PAM_CONV_ERR</term>
75 <term>PAM_SUCCESS</term>
78 Transaction was successful created.
83 <term>PAM_SYSTEM_ERR</term>
94 <refsect1 id='pam_prompt-see_also'>
95 <title>SEE ALSO</title>
98 <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
101 <refentrytitle>pam_conv</refentrytitle><manvolnum>3</manvolnum>
106 <refsect1 id='pam_prompt-standards'>
107 <title>STANDARDS</title>
109 The <function>pam_prompt</function> and <function>pam_vprompt</function>
110 functions are Linux-PAM extensions.