Unbind (LDAP function): Difference between revisions
Jump to navigation
Jump to search
(Created page with " <span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> Unbind function <p> <var>Unbind</var> is a member of the <var>[[Ldap...") |
m (1 revision) |
||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:LDAP:Unbind subtitle}} | |||
This [[Notation conventions for methods#Callable functions|callable]] | |||
This [[Notation conventions for methods#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 | ||
data on the connection and deactivates it. | data on the connection and deactivates it. | ||
==Syntax== | ==Syntax== | ||
{{Template:LDAP:Unbind syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table> | <table class="syntaxTable"> | ||
<tr><th | <tr><th>%number</th> | ||
<td>A float variable to contain the status result of the Unbind. Possible results are: | |||
<ul> | |||
<li>0, which indicates success | |||
<li>-1, which indicates a failure due to a lost connection (or a connection was never established) | |||
</ul> | |||
The <var>[[ErrorNumber ( | The <var>[[ErrorNumber (LDAP function)|ErrorNumber]]</var> and <var>[[ErrorText (LDAP function)|ErrorText]]</var> methods may provide additional details. </td></tr> | ||
</td></tr> | <tr><th>ldap</th> | ||
<tr><th> | <td>An <var>LDAP</var> object variable. | ||
</td></tr></table> | </td></tr></table> | ||
==Usage | |||
==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), | ||
the <var> | the <var>LDAP</var> method object is ready for another <var>Bind</var>: | ||
that is, it is (re)initialized with no associated socket/connection references, | that is, it is (re)initialized with no associated socket/connection references, | ||
in the same state as if <code>%ld = New</code> were issued. | in the same state as if <code>%ld = New</code> were issued. | ||
<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> | a <var>Discard</var> call, and you can achieve the same result by letting an <var>LDAP</var> object | ||
get discarded automatically ( | get discarded automatically ("implicitly") 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}} | |||
Latest revision as of 21:47, 26 August 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
| %number | A float variable to contain the status result of the Unbind. Possible results are:
|
|---|---|
| ldap | 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 ("implicitly") when the last reference to it is lost, but it is recommended that you first issue an Unbind call for a more orderly closure.