contrib/openpam/doc/man/pam_end.3

   1 .\" Generated from pam_end.c by gendoc.pl
   2 .\" $OpenPAM: pam_end.c 938 2017-04-30 21:34:42Z des $
   3 .Dd February 24, 2019
   4 .Dt PAM_END 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_end
   8 .Nd terminate the PAM transaction
   9 .Sh SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .Ft "int"
  13 .Fn pam_end "pam_handle_t *pamh" "int status"
  14 .Sh DESCRIPTION
  15 The
  16 .Fn pam_end
  17 function terminates a PAM transaction and destroys the
  18 corresponding PAM context, releasing all resources allocated to it.
  19 .Pp
  20 The
  21 .Fa status
  22 argument should be set to the error code returned by the
  23 last API call before the call to
  24 .Fn pam_end .
  25 .Sh RETURN VALUES
  26 The
  27 .Fn pam_end
  28 function returns one of the following values:
  29 .Bl -tag -width 18n
  30 .It Bq Er PAM_SUCCESS
  31 Success.
  32 .It Bq Er PAM_BAD_HANDLE
  33 Invalid PAM handle.
  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 Mt des@des.no .