xref: /freebsd/contrib/openpam/doc/man/openpam_get_option.3 (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
1.\" Generated from openpam_get_option.c by gendoc.pl
2.\" $Id: openpam_get_option.c 648 2013-03-05 17:54:27Z des $
3.Dd September 12, 2014
4.Dt OPENPAM_GET_OPTION 3
5.Os
6.Sh NAME
7.Nm openpam_get_option
8.Nd returns the value of a module option
9.Sh LIBRARY
10.Lb libpam
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.In security/openpam.h
15.Ft "const char *"
16.Fn openpam_get_option "pam_handle_t *pamh" "const char *option"
17.Sh DESCRIPTION
18The
19.Fn openpam_get_option
20function returns the value of the specified
21option in the context of the currently executing service module, or
22.Dv NULL
23if the option is not set or no module is currently executing.
24.Pp
25.Sh RETURN VALUES
26The
27.Fn openpam_get_option
28function returns
29.Dv NULL
30on failure.
31.Sh SEE ALSO
32.Xr openpam_set_option 3 ,
33.Xr pam 3
34.Sh STANDARDS
35The
36.Fn openpam_get_option
37function is an OpenPAM extension.
38.Sh AUTHORS
39The
40.Fn openpam_get_option
41function and this manual page were
42developed for the
43.Fx
44Project by ThinkSec AS and Network Associates Laboratories, the
45Security Research Division of Network Associates, Inc.\& under
46DARPA/SPAWAR contract N66001-01-C-8035
47.Pq Dq CBOSS ,
48as part of the DARPA CHATS research program.
49.Pp
50The OpenPAM library is maintained by
51.An Dag-Erling Sm\(/orgrav Aq des@des.no .
52