source: openpam/trunk/doc/man/openpam_get_option.3 @ 93

Last change on this file since 93 was 93, checked in by Dag-Erling Smørgrav, 19 years ago

s/Technologies/Technology/ in copyright, and regenerate docs.

File size: 2.7 KB
Line 
1.\"-
2.\" Copyright (c) 2002 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" NAI Labs, the Security Research Division of Network Associates, Inc.
7.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8.\" DARPA CHATS research program.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. The name of the author may not be used to endorse or promote
19.\"    products derived from this software without specific prior written
20.\"    permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $P4: //depot/projects/openpam/doc/man/openpam_get_option.3#4 $
35.\"
36.Dd March 7, 2002
37.Dt OPENPAM_GET_OPTION 3
38.Os
39.Sh NAME
40.Nm openpam_get_option
41.Nd returns the value of a module option
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In security/pam_appl.h
46.Ft const char *
47.Fn openpam_get_option "pam_handle_t *pamh" "const char *option"
48.Sh DESCRIPTION
49The
50.Nm
51function returns the value of the specified
52option in the context of the currently executing service module, or
53.Dv NULL
54if the option is not set or no module is currently executing.
55.Sh RETURN VALUES
56The
57.Nm
58function returns
59.Dv NULL
60on failure.
61.Sh SEE ALSO
62.Xr pam 3
63.Sh STANDARDS
64The
65.Nm
66function is an OpenPAM extension.
67.Sh AUTHORS
68The
69.Nm
70function and this manual page were developed for the FreeBSD Project
71by ThinkSec AS and NAI Labs, the Security Research Division of Network
72Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
73.Pq Dq CBOSS ,
74as part of the DARPA CHATS research program.
Note: See TracBrowser for help on using the repository browser.