Next Entry

This LDAP tool reads an LDAP entry in a search result object (generated with the search tool) and moves the iterator to the next element in the search result object.

For example, the Search tool generates a search result object with 3 entries and initializes the iterator to point to the first element, as shown in the following table. The Search tool automatically places the iterator at the first element when it creates the list.

See Introduction to LDAP tools for more information on using this tool.

Search Result Object containing 3 elements.

Element #	Iterator
0	•
1
2

 

The Next Entry tool extracts the entry ID from the element to which the iterator is pointing and places it in the Entry output parameter. (You can then use the Get Entry Attribute tool to extract the value of one of that entry's attributes. See the Search tool documentation for more information on selecting the attribute values to return with the search.)

Now the next entry tool moves the iterator to the next element in the search result object, as shown in the following figure:

Element #	Iterator
0
1	•
2

 

The next time the Next Entry tool executes, it extracts the entry id from the element to which the iterator is pointing, then moves the iterator to the next element, as shown in the following figure:

Element #	Iterator
0
1
2	•

The next time the Next Entry tool executes, it see that the iterator is pointing to the last element in the list, extracts no information, and takes the End of List exit path.

Inputs

Entries

This is the handle (output by the Search tool) to the search result object containing the matching entries. You can pass this handle to the Get Entry Attribute tool.

Start Iteration?

False by default. Set this value to True to reset the iterator to point to the first element in the list. You would use this if you wanted to cycle through the list again. Set this value to false to not move the iterator from the element to which it currently points.

Outputs

Entry

A handle to the entry that was read from the search result object. You can pass this entry handle to the Get Entry Attribute tool.

Error Code

The code associated with a processing error.

Error Message

A string description describing the error that occurred.

Error Native

A string description of an error that occurred in the LDAPLib module that connects this CIC server to your LDAP Server.

Exit Paths

Success

This tool takes the Success path if the entry was correctly read and if the iterator was moved to the next entry in the list.

End of List

This tool takes the End of List exit path if the iterator was moved to the last element in the list.

Failure  

This tool takes the Failure exit path if an error occurred. Examine the output error text to determine the problem.