path: root/doc/man/pam_end.3
diff options
Diffstat (limited to 'doc/man/pam_end.3')
1 files changed, 52 insertions, 1 deletions
diff --git a/doc/man/pam_end.3 b/doc/man/pam_end.3
index 06fdabb9..e074c6c5 100644
--- a/doc/man/pam_end.3
+++ b/doc/man/pam_end.3
@@ -1 +1,52 @@ man3/pam_start.3
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "PAM_END" "3" "02/12/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.\" disable justification (adjust text to left margin only) l
+pam_end \- termination of PAM transaction
+\fB#include <security/pam_appl.h>\fR
+.HP 12
+\fBint\ \fBpam_end\fR\fR\fB(\fR\fBpam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBint\ \fR\fB\fIpam_status\fR\fR\fB);\fR
+function terminates the PAM transaction and is the last function an application should call in the PAM contenxt. Upon return the handle
+is no longer valid and all memory associated with it will be invalid.
+argument should be set to the value returned to the application by the last PAM library call.
+The value taken by
+is used as an argument to the module specific callback function,
+\fBpam_get_data\fR(3)). In this way the module can be given notification of the pass/fail nature of the tear\-down process, and perform any last minute tasks that are appropriate to the module before it is unlinked. This argument can be logically OR'd with
+to indicate to indicate that the module should not treat the call too seriously. It is generally used to indicate that the current closing of the library is in a
+\fBfork\fR(2)ed process, and that the parent will take care of cleaning up things that exist outside of the current process space (files etc.).
+Transaction was successful terminated.
+System error, for example a NULL pointer was submitted as PAM handle or the function was called by a module.