xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_get_option.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.\"	$NetBSD: openpam_get_option.3,v 1.8 2019/12/15 17:08:21 christos Exp $
2.\"
3.\" Generated from openpam_get_option.c by gendoc.pl
4.\" $OpenPAM: openpam_get_option.c 938 2017-04-30 21:34:42Z des $
5.Dd February 24, 2019
6.Dt OPENPAM_GET_OPTION 3
7.Os
8.Sh NAME
9.Nm openpam_get_option
10.Nd returns the value of a module option
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.Sh RETURN VALUES
25The
26.Fn openpam_get_option
27function returns
28.Dv NULL
29on failure.
30.Sh SEE ALSO
31.Xr openpam_set_option 3 ,
32.Xr pam 3
33.Sh STANDARDS
34The
35.Fn openpam_get_option
36function is an OpenPAM extension.
37.Sh AUTHORS
38The
39.Fn openpam_get_option
40function and this manual page were
41developed for the
42.Fx
43Project by ThinkSec AS and Network Associates Laboratories, the
44Security Research Division of Network Associates, Inc.\& under
45DARPA/SPAWAR contract N66001-01-C-8035
46.Pq Dq CBOSS ,
47as part of the DARPA CHATS research program.
48.Pp
49The OpenPAM library is maintained by
50.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
51