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