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