contrib/openpam/doc/man/openpam_get_option.3

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