ErrorText (LDAP function): Difference between revisions
Jump to navigation
Jump to search
m (moved ErrorText (LDAP property) to ErrorText (LDAP function)) |
m (moved ErrorText (LDAP property) to ErrorText (LDAP function)) |
||
| Line 1: | Line 1: | ||
{{Template:LDAP:ErrorText subtitle}} | |||
This method is a read-only property that reports the error message text from the | This method is a read-only property that reports the error message text from the | ||
last <var>Ldap</var> method for which an error message was returned. | last <var>Ldap</var> method for which an error message was returned. | ||
==Syntax== | ==Syntax== | ||
{{Template:LDAP:ErrorText syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table> | <table> | ||
| Line 19: | Line 13: | ||
</th><td>An <var>Ldap</var> object variable. | </th><td>An <var>Ldap</var> object variable. | ||
</td></tr></table> | </td></tr></table> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The <var>[[ErrorNumber (Ldap property)|ErrorNumber]]</var> property reports | <li>The <var>[[ErrorNumber (Ldap property)|ErrorNumber]]</var> property reports | ||
| Line 26: | Line 20: | ||
<li>The <var>ErrorText</var> message will be the same as that indicated by the status | <li>The <var>ErrorText</var> message will be the same as that indicated by the status | ||
return from <var>Ldap</var> methods | return from <var>Ldap</var> methods | ||
for problems “internal” to the client, will be a message from a | for problems &ldquo;internal&rdquo; to the client, will be a message from a | ||
related error, or will be a message from a server-reported error. | related error, or will be a message from a server-reported error. | ||
<li>If an <var>ErrorText</var> message (and number) contain information reported by the | <li>If an <var>ErrorText</var> message (and number) contain information reported by the | ||
| Line 45: | Line 39: | ||
<var>ErrorText</var> and returned status provide corroborating information. | <var>ErrorText</var> and returned status provide corroborating information. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:LDAP:ErrorText footer}} | |||
Revision as of 22:54, 8 July 2011
Error message of the most recent LDAP error (LDAP class)
This method is a read-only property that reports the error message text from the
last Ldap method for which an error message was returned.
Syntax
%string = ldap:ErrorText
Syntax terms
| %msg | A string variable to contain the returned error message text. The %msg value is an empty string if no methods have been called. |
|---|---|
| %ld | An Ldap object variable. |
Usage notes
- The ErrorNumber property reports the error number associated with the ErrorText message or a number of a related error.
- The ErrorText message will be the same as that indicated by the status return from Ldap methods for problems “internal” to the client, will be a message from a related error, or will be a message from a server-reported error.
- If an ErrorText message (and number) contain information reported by the server, they may conform to the LDAP RFC, which lists dozens of such server result codes (positive integers) and descriptions, but no accompanying diagnostic text for these codes is standardized.
Examples
- An Ldap Bind call fails and returns a status value of
-5, which indicates that the bind authorization failed. When the following statement was issued:Print 'Error text is ': ' %ld:ErrorText
The result was:
Error text is LDBIND FTPCONN failed to connect. ErrorText and returned status provide corroborating information.