ErrorText (LDAP function)

<section begin=dpl_desc/><section end=dpl_desc/>

ErrorText is a member of the 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

%msg = %ld: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.