1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav 4.\" All rights reserved. 5.\" 6.\" This software was developed for the FreeBSD Project by ThinkSec AS and 7.\" Network Associates Laboratories, the Security Research Division of 8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 9.\" ("CBOSS"), as part of the DARPA CHATS research program. 10.\" 11.\" Redistribution and use in source and binary forms, with or without 12.\" modification, are permitted provided that the following conditions 13.\" are met: 14.\" 1. Redistributions of source code must retain the above copyright 15.\" notice, this list of conditions and the following disclaimer. 16.\" 2. Redistributions in binary form must reproduce the above copyright 17.\" notice, this list of conditions and the following disclaimer in the 18.\" documentation and/or other materials provided with the distribution. 19.\" 3. The name of the author may not be used to endorse or promote 20.\" products derived from this software without specific prior written 21.\" permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.\" $Id$ 36.\" 37.Dd May 26, 2012 38.Dt PAM_STRERROR 3 39.Os 40.Sh NAME 41.Nm pam_strerror 42.Nd get PAM standard error message string 43.Sh LIBRARY 44.Lb libpam 45.Sh SYNOPSIS 46.In sys/types.h 47.In security/pam_appl.h 48.Ft "const char *" 49.Fn pam_strerror "const pam_handle_t *pamh" "int error_number" 50.Sh DESCRIPTION 51The 52.Fn pam_strerror 53function returns a pointer to a string containing a 54textual description of the error indicated by the 55.Fa error_number 56argument. 57The 58.Fa pamh 59argument is ignored. 60For compatibility with other implementations, it should be either a 61valid PAM handle returned by a previous call to 62.Xr pam_start 3 , 63or 64.Dv NULL . 65.Sh RETURN VALUES 66The 67.Fn pam_strerror 68function returns 69.Dv NULL 70on failure. 71.Sh SEE ALSO 72.Xr pam 3 , 73.Xr pam_start 3 74.Sh STANDARDS 75.Rs 76.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 77.%D "June 1997" 78.Re 79.Sh AUTHORS 80The 81.Fn pam_strerror 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