Unbind (LDAP function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Syntax terms) |
||
| Line 8: | Line 8: | ||
{{Template:LDAP:Unbind 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 (LDAP function)|ErrorNumber]]</var> and <var>[[ErrorText (LDAP function)|ErrorText]]</var> methods may provide additional details. | 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> | ||
Revision as of 23:26, 15 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 (&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.