Share this page

# mldap_get_next_entry

Listing Directory Functions (mldap)

Displays the next search result.

    char *mldap_get_next_entry( char *transaction, [char *timeout,] [char *param,] LAST );

transaction | A transaction name for this step. To instruct VuGen not to create a transaction for this step, use a NULL string, "".
timeout | The timeout in seconds. After the timeout is reached, VuGen aborts the search. The default is 30 seconds. This argument is ignored for synchronous searches. Use the following format: `"Timeout=`value`"`
param | The name of a parameter storing the results. Use the following format: `"Param=`name`"`
LAST | A marker indicating the end of the argument list.

The mldap_get_next_entry function displays the next entry resulting from a search. For asynchronous searches, this function retrieves and displays the entry; for synchronous searches, it only displays the next entry. The function returns the name of the DN entry, but you can also instruct it to save it to a parameter. If there are no more entries, or if there was an error in retrieving an entry, the function returns NULL.

This function is for use with global sessions. For multiple sessions, use the mldap_get_next_entry_ex function, which allows you to specify a session identifier.

This function is not recorded. Add it if needed when enhancing your script.

## Return Values

This function returns the name of the next entry, or NULL if no entries are available or if there is an error.

## Parameterization

The following argument(s) can be parameterized with standard parameterization: param

## Example

In the following example, the mldap_get_next_entry function gets the next entry in a while loop.

    while (mldap_get_next_entry("LDAP Get Next Entry",
            LAST)) {
            ...
        }

In the following example, the mldap_get_next_entry function retrieves the entry and saves it to parameter xyz.

    mldap_get_next_entry("LDAP Get Next Entry",
        "Timeout=15",
        "Param=xyz",
        LAST );

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: