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

   1 .\"     Title: pam_error
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
   4 .\"      Date: 06/27/2006
   5 .\"    Manual: Linux\-PAM Manual
   6 .\"    Source: Linux\-PAM Manual
   7 .\"
   8 .TH "PAM_ERROR" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 pam_error, pam_verror \- display error messages to the user
  15 .SH "SYNOPSIS"
  16 .sp
  17 .ft B
  18 .nf
  19 #include <security/pam_ext.h>
  20 .fi
  21 .ft
  22 .HP 14
  23 .BI "int pam_error(pam_handle_t\ *" "pamh" ", const\ char\ *" "fmt" ", " "..." ");"
  24 .HP 15
  25 .BI "int pam_verror(pam_handle_t\ *" "pamh" ", const\ char\ *" "fmt" ", va_list\ " "args" ");"
  26 .SH "DESCRIPTION"
  27 .PP
  28 The
  29 \fBpam_error\fR
  30 function prints error messages through the conversation function to the user.
  31 .PP
  32 The
  33 \fBpam_verror\fR
  34 function performs the same task as
  35 \fBpam_error()\fR
  36 with the difference that it takes a set of arguments which have been obtained using the
  37 \fBstdarg\fR(3)
  38 variable argument list macros.
  39 .SH "RETURN VALUES"
  40 .TP 3n
  41 PAM_BUF_ERR
  42 Memory buffer error.
  43 .TP 3n
  44 PAM_CONV_ERR
  45 Conversation failure.
  46 .TP 3n
  47 PAM_SUCCESS
  48 Error message was displayed.
  49 .TP 3n
  50 PAM_SYSTEM_ERR
  51 System error.
  52 .SH "SEE ALSO"
  53 .PP
  54
  55 \fBpam_info\fR(3),
  56 \fBpam_vinfo\fR(3),
  57 \fBpam_prompt\fR(3),
  58 \fBpam_vprompt\fR(3),
  59 \fBpam\fR(8)
  60 .SH "STANDARDS"
  61 .PP
  62 The
  63 \fBpam_error\fR
  64 and
  65 \fBpam_verror\fR
  66 functions are Linux\-PAM extensions.