ErrorNumber (LDAP function)

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

ErrorNumber is a member of the Ldap class.

This method is a read-only property that reports the error number from the last Ldap method for which an error number was returned.

Syntax

%num = %ld:ErrorNumber

Syntax terms

%num	A float variable to contain the integer-valued error number.
%ld	An Ldap object variable.

Usage Notes

• The ErrorText property reports a short description of the error associated with the ErrorNumber value or additional information related to the error.
• The ErrorNumber value will be the same as the status return from Ldap methods for problems "internal" to the client, will contain a value from a related error, or will contain a value from a server-reported error.
• If an ErrorNumber (and text) 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 -110, which indicates a problem with the Janus port definition. When the following statement was issued:

  Print 'Error number is ': ' %ld:ErrorNumber

  The result was: Error number is -110. ErrorNumber and status return both point to the client fault.

• An Ldap Find call fails and returns a status value of -5, which indicates an "error obtained from server." When the following statement was issued:

  Print 'Error number is ': ' %ld:ErrorNumber

  The result was: Error number is 4, and the ErrorText string indicated that "the size limit of returned entries has been exceeded." ErrorNumber and status return, though different, both point to a server issue.