1.\" $NetBSD: pam_strerror.3,v 1.2 2011/12/25 22:27:55 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 December 25, 2011 40.Dt PAM_STRERROR 3 41.Os 42.Sh NAME 43.Nm pam_strerror 44.Nd get PAM standard error message string 45.Sh LIBRARY 46.Lb libpam 47.Sh SYNOPSIS 48.In sys/types.h 49.In security/pam_appl.h 50.Ft "const char *" 51.Fn pam_strerror "const pam_handle_t *pamh" "int error_number" 52.Sh DESCRIPTION 53The 54.Nm 55function returns a pointer to a string containing a 56textual description of the error indicated by the 57.Fa error_number 58argument. 59argument, in the context of the PAM transaction described by the 60.Fa pamh 61The 62.Fa pamh 63argument is ignored. 64For compatibility with other implementations, it should be either a 65valid PAM handle returned by a previous call to 66.Xr pam_start 3 , 67or 68.Dv NULL . 69.Sh RETURN VALUES 70The 71.Nm 72function returns 73.Dv NULL 74on failure. 75.Sh SEE ALSO 76.Xr pam 3 , 77.Xr pam_start 3 78.Sh STANDARDS 79.Rs 80.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 81.%D "June 1997" 82.Re 83.Sh AUTHORS 84The 85.Nm 86function and this manual page were developed for the 87.Fx 88Project by 89ThinkSec AS and Network Associates Laboratories, the 90Security Research Division of Network Associates, Inc.\& under 91DARPA/SPAWAR contract N66001-01-C-8035 92.Pq Dq CBOSS , 93as part of the DARPA CHATS research program. 94