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