contrib/openpam/doc/man/pam_end.3

   1 .\" Generated from pam_end.c by gendoc.pl
   2 .\" $Id: pam_end.c 648 2013-03-05 17:54:27Z des $
   3 .Dd September 7, 2013
   4 .Dt PAM_END 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_end
   8 .Nd terminate the PAM transaction
   9 .Sh LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .Ft "int"
  15 .Fn pam_end "pam_handle_t *pamh" "int status"
  16 .Sh DESCRIPTION
  17 The
  18 .Fn pam_end
  19 function terminates a PAM transaction and destroys the
  20 corresponding PAM context, releasing all resources allocated to it.
  21 .Pp
  22 The
  23 .Fa status
  24 argument should be set to the error code returned by the
  25 last API call before the call to
  26 .Fn pam_end .
  27 .Sh RETURN VALUES
  28 The
  29 .Fn pam_end
  30 function returns one of the following values:
  31 .Bl -tag -width 18n
  32 .It Bq Er PAM_SYSTEM_ERR
  33 System error.
  34 .El
  35 .Sh SEE ALSO
  36 .Xr pam 3 ,
  37 .Xr pam_strerror 3
  38 .Sh STANDARDS
  39 .Rs
  40 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  41 .%D "June 1997"
  42 .Re
  43 .Sh AUTHORS
  44 The
  45 .Fn pam_end
  46 function and this manual page were
  47 developed for the
  48 .Fx
  49 Project by ThinkSec AS and Network Associates Laboratories, the
  50 Security Research Division of Network Associates, Inc.\& under
  51 DARPA/SPAWAR contract N66001-01-C-8035
  52 .Pq Dq CBOSS ,
  53 as part of the DARPA CHATS research program.
  54 .Pp
  55 The OpenPAM library is maintained by
  56 .An Dag-Erling Sm\(/orgrav Aq des@des.no .