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