pam_error.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. '\" t
  2. .\" Title: pam_error
  3. .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 09/03/2021
  6. .\" Manual: Linux-PAM Manual
  7. .\" Source: Linux-PAM Manual
  8. .\" Language: English
  9. .\"
  10. .TH "PAM_ERROR" "3" "09/03/2021" "Linux-PAM Manual" "Linux-PAM Manual"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. pam_error, pam_verror \- display error messages to the user
  32. .SH "SYNOPSIS"
  33. .sp
  34. .ft B
  35. .nf
  36. #include <security/pam_ext\&.h>
  37. .fi
  38. .ft
  39. .HP \w'int\ pam_error('u
  40. .BI "int pam_error(pam_handle_t\ *" "pamh" ", const\ char\ *" "fmt" ", " "\&.\&.\&." ");"
  41. .HP \w'int\ pam_verror('u
  42. .BI "int pam_verror(pam_handle_t\ *" "pamh" ", const\ char\ *" "fmt" ", va_list\ " "args" ");"
  43. .SH "DESCRIPTION"
  44. .PP
  45. The
  46. \fBpam_error\fR
  47. function prints error messages through the conversation function to the user\&.
  48. .PP
  49. The
  50. \fBpam_verror\fR
  51. function performs the same task as
  52. \fBpam_error()\fR
  53. with the difference that it takes a set of arguments which have been obtained using the
  54. \fBstdarg\fR(3)
  55. variable argument list macros\&.
  56. .SH "RETURN VALUES"
  57. .PP
  58. PAM_BUF_ERR
  59. .RS 4
  60. Memory buffer error\&.
  61. .RE
  62. .PP
  63. PAM_CONV_ERR
  64. .RS 4
  65. Conversation failure\&.
  66. .RE
  67. .PP
  68. PAM_SUCCESS
  69. .RS 4
  70. Error message was displayed\&.
  71. .RE
  72. .PP
  73. PAM_SYSTEM_ERR
  74. .RS 4
  75. System error\&.
  76. .RE
  77. .SH "SEE ALSO"
  78. .PP
  79. \fBpam_info\fR(3),
  80. \fBpam_vinfo\fR(3),
  81. \fBpam_prompt\fR(3),
  82. \fBpam_vprompt\fR(3),
  83. \fBpam\fR(8)
  84. .SH "STANDARDS"
  85. .PP
  86. The
  87. \fBpam_error\fR
  88. and
  89. \fBpam_verror\fR
  90. functions are Linux\-PAM extensions\&.