xref: /freebsd/contrib/openpam/doc/man/openpam_set_feature.3 (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
1.\" Generated from openpam_set_feature.c by gendoc.pl
2.Dd June 27, 2023
3.Dt OPENPAM_SET_FEATURE 3
4.Os
5.Sh NAME
6.Nm openpam_set_feature
7.Nd enable or disable an optional feature
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.In security/openpam.h
12.Ft "int"
13.Fn openpam_set_feature "int feature" "int onoff"
14.Sh DESCRIPTION
15.Bf Sy
16This function is experimental and may be modified or removed in a future release without prior warning.
17.Ef
18.Pp
19The
20.Fn openpam_set_feature
21function sets the state of the specified
22feature to the value specified by the
23.Fa onoff
24argument.
25See
26.Xr openpam_get_feature 3
27for a list of recognized features.
28.Pp
29.Sh RETURN VALUES
30The
31.Fn openpam_set_feature
32function returns one of the following values:
33.Bl -tag -width 18n
34.It Bq Er PAM_SUCCESS
35Success.
36.It Bq Er PAM_BAD_FEATURE
37Unrecognized or restricted feature.
38.El
39.Sh SEE ALSO
40.Xr openpam_get_feature 3 ,
41.Xr pam 3 ,
42.Xr pam_strerror 3
43.Sh STANDARDS
44The
45.Fn openpam_set_feature
46function is an OpenPAM extension.
47.Sh AUTHORS
48The
49.Fn openpam_set_feature
50function and this manual page were
51developed by
52.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
53