Unbind (LDAP function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Template:LDAP:Unbind subtitle}}
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:Ldap methods|Unbind function]]
<p>
<var>Unbind</var> is a member of the <var>[[Ldap class|Ldap]]</var> class.
</p>


This [[Notation conventions for methods#Callable methods|callable]]
This [[Notation conventions for methods#Callable methods|callable]]
Line 11: Line 6:
data on the connection and deactivates it.
data on the connection and deactivates it.
==Syntax==
==Syntax==
<p class="syntax">[%st =] %ld:Unbind
{{Template:LDAP:Unbind syntax}}
</p>
===Syntax terms===
===Syntax terms===
<table>
<table>
Line 23: Line 17:
</th><td>An <var>Ldap</var> object variable.
</th><td>An <var>Ldap</var> object variable.
</td></tr></table>
</td></tr></table>
==Usage Notes==
==Usage notes==
<ul>
<ul>
<li>After a successful <var>Unbind</var> (and after errors that cause a disconnection),
<li>After a successful <var>Unbind</var> (and after errors that cause a disconnection),
Line 31: Line 25:
<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 (&ldquo;implicitly&rdquo;) when the last
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
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.
</ul>
</ul>
==See also==
{{Template:LDAP:Unbind footer}}

Revision as of 22:54, 8 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:
  • 0, which indicates success
  • -1, which indicates a failure due to a lost connection (or a connection was never established)

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 = New were 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 (&ldquo;implicitly&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.

See also