1.\" $NetBSD: pam_error.3,v 1.3 2013/04/06 02:20:27 christos Exp $ 2.\" 3.\"- 4.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 5.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav 6.\" All rights reserved. 7.\" 8.\" This software was developed for the FreeBSD Project by ThinkSec AS and 9.\" Network Associates Laboratories, the Security Research Division of 10.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 11.\" ("CBOSS"), as part of the DARPA CHATS research program. 12.\" 13.\" Redistribution and use in source and binary forms, with or without 14.\" modification, are permitted provided that the following conditions 15.\" are met: 16.\" 1. Redistributions of source code must retain the above copyright 17.\" notice, this list of conditions and the following disclaimer. 18.\" 2. Redistributions in binary form must reproduce the above copyright 19.\" notice, this list of conditions and the following disclaimer in the 20.\" documentation and/or other materials provided with the distribution. 21.\" 3. The name of the author may not be used to endorse or promote 22.\" products derived from this software without specific prior written 23.\" permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35.\" SUCH DAMAGE. 36.\" 37.\" Id 38.\" 39.Dd May 26, 2012 40.Dt PAM_ERROR 3 41.Os 42.Sh NAME 43.Nm pam_error 44.Nd display an error message 45.Sh LIBRARY 46.Lb libpam 47.Sh SYNOPSIS 48.In sys/types.h 49.In security/pam_appl.h 50.Ft "int" 51.Fn pam_error "const pam_handle_t *pamh" "const char *fmt" "..." 52.Sh DESCRIPTION 53The 54.Fn pam_error 55function displays an error message through the 56intermediary of the given PAM context's conversation function. 57.Sh RETURN VALUES 58The 59.Fn pam_error 60function returns one of the following values: 61.Bl -tag -width 18n 62.It Bq Er PAM_BUF_ERR 63Memory buffer error. 64.It Bq Er PAM_CONV_ERR 65Conversation failure. 66.It Bq Er PAM_SYSTEM_ERR 67System error. 68.El 69.Sh SEE ALSO 70.Xr pam 3 , 71.Xr pam_info 3 , 72.Xr pam_prompt 3 , 73.Xr pam_strerror 3 , 74.Xr pam_verror 3 75.Sh STANDARDS 76The 77.Fn pam_error 78function is an OpenPAM extension. 79.Sh AUTHORS 80The 81.Fn pam_error 82function and this manual page were 83developed for the 84.Fx 85Project by ThinkSec AS and Network Associates Laboratories, the 86Security Research Division of Network Associates, Inc.\& under 87DARPA/SPAWAR contract N66001-01-C-8035 88.Pq Dq CBOSS , 89as part of the DARPA CHATS research program. 90