]> CyberLeo.Net >> Repos - FreeBSD/releng/10.0.git/blob - contrib/openpam/doc/man/openpam_get_option.3
- Copy stable/10 (r259064) to releng/10.0 as part of the
[FreeBSD/releng/10.0.git] / contrib / openpam / doc / man / openpam_get_option.3
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 7, 2013
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
18 The
19 .Fn openpam_get_option
20 function returns the value of the specified
21 option in the context of the currently executing service module, or
22 .Dv NULL
23 if the option is not set or no module is currently executing.
24 .Pp
25 .Sh RETURN VALUES
26 The
27 .Fn openpam_get_option
28 function returns
29 .Dv NULL
30 on failure.
31 .Sh SEE ALSO
32 .Xr openpam_set_option 3 ,
33 .Xr pam 3
34 .Sh STANDARDS
35 The
36 .Fn openpam_get_option
37 function is an OpenPAM extension.
38 .Sh AUTHORS
39 The
40 .Fn openpam_get_option
41 function and this manual page were
42 developed for the
43 .Fx
44 Project by ThinkSec AS and Network Associates Laboratories, the
45 Security Research Division of Network Associates, Inc.\& under
46 DARPA/SPAWAR contract N66001-01-C-8035
47 .Pq Dq CBOSS ,
48 as part of the DARPA CHATS research program.
49 .Pp
50 The OpenPAM library is maintained by
51 .An Dag-Erling Sm\(/orgrav Aq des@des.no .