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