Unbind (LDAP function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Syntax terms) |
||
| Line 12: | Line 12: | ||
</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> | </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 | 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><i><b>%ld</b></i> | <tr><th><i><b>%ld</b></i> | ||
</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> | ||
Revision as of 23:03, 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:
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 (&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.