Unbind (LDAP function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Syntax terms) |
||
| Line 1: | Line 1: | ||
{{Template:LDAP:Unbind subtitle}} | {{Template:LDAP:Unbind subtitle}} | ||
This [[Notation conventions for methods#Callable | This [[Notation conventions for methods#Callable functions|callable]] | ||
function closes a Janus LDAP connection. | function closes a Janus LDAP connection. | ||
It logs off the LDAP user, and it terminates the sending and receiving of | It logs off the LDAP user, and it terminates the sending and receiving of | ||
| Line 26: | Line 26: | ||
<li>You can also close a connection (and delete the object) abruptly by issuing | <li>You can also close a connection (and delete the object) abruptly by issuing | ||
a <var>Discard</var> call, and you can achieve the same result by letting an <var>Ldap</var> object | a <var>Discard</var> call, and you can achieve the same result by letting an <var>Ldap</var> object | ||
get discarded automatically (&amp;ldquo;implicitly&amp;rdquo;) when the last | get discarded automatically (&amp;amp;ldquo;implicitly&amp;amp;rdquo;) when the last | ||
reference to it is lost, but it is recommended that you first issue an | reference to it is lost, but it is recommended that you first issue an | ||
<var>Unbind</var> call for a more orderly closure. | <var>Unbind</var> call for a more orderly closure. | ||
Revision as of 19:40, 14 July 2011
Close this LDAP connection (LDAP class)
This callable
function closes a Janus LDAP connection.
It logs off the LDAP user, and it terminates the sending and receiving of
data on the connection and deactivates it.
Syntax
[%number =] ldap:Unbind
Syntax terms
| %st | A float variable to contain the status result of the Unbind. Possible results are:
The ErrorNumber and ErrorText methods may provide additional details. |
|---|---|
| %ld | An Ldap object variable. |
Usage notes
- After a successful Unbind (and after errors that cause a disconnection),
the Ldap method object is ready for another Bind:
that is, it is (re)initialized with no associated socket/connection references,
in the same state as if
%ld = Newwere issued. - You can also close a connection (and delete the object) abruptly by issuing a Discard call, and you can achieve the same result by letting an Ldap object get discarded automatically (&amp;ldquo;implicitly&amp;rdquo;) when the last reference to it is lost, but it is recommended that you first issue an Unbind call for a more orderly closure.