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