]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/openpam/doc/man/openpam_set_option.3
Upgrade to OpenPAM Tabebuia.
[FreeBSD/FreeBSD.git] / contrib / openpam / doc / man / openpam_set_option.3
1 .\" Generated from openpam_set_option.c by gendoc.pl
2 .\" $OpenPAM: openpam_set_option.c 938 2017-04-30 21:34:42Z des $
3 .Dd February 24, 2019
4 .Dt OPENPAM_SET_OPTION 3
5 .Os
6 .Sh NAME
7 .Nm openpam_set_option
8 .Nd sets 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 "int"
14 .Fn openpam_set_option "pam_handle_t *pamh" "const char *option" "const char *value"
15 .Sh DESCRIPTION
16 The
17 .Fn openpam_set_option
18 function sets the specified option in the
19 context of the currently executing service module.
20 .Pp
21 .Sh RETURN VALUES
22 The
23 .Fn openpam_set_option
24 function returns one of the following values:
25 .Bl -tag -width 18n
26 .It Bq Er PAM_SUCCESS
27 Success.
28 .It Bq Er PAM_BUF_ERR
29 Memory buffer error.
30 .It Bq Er PAM_SYSTEM_ERR
31 System error.
32 .El
33 .Sh SEE ALSO
34 .Xr openpam_get_option 3 ,
35 .Xr pam 3 ,
36 .Xr pam_strerror 3
37 .Sh STANDARDS
38 The
39 .Fn openpam_set_option
40 function is an OpenPAM extension.
41 .Sh AUTHORS
42 The
43 .Fn openpam_set_option
44 function and this manual page were
45 developed for the
46 .Fx
47 Project by ThinkSec AS and Network Associates Laboratories, the
48 Security Research Division of Network Associates, Inc.\& under
49 DARPA/SPAWAR contract N66001-01-C-8035
50 .Pq Dq CBOSS ,
51 as part of the DARPA CHATS research program.
52 .Pp
53 The OpenPAM library is maintained by
54 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .