ldap_free_sort_keylist()--Free all Memory used by the Sort Key List

 #include <ldap.h>
 
 void ldap_free_sort_keylist(
              LDAPsortkey **sortKeyList)

The ldap_free_sort_keylist() function is used to free all the memory used by the sort key list. This function must be called after the ldap_create_sort_control() function has completed.

See Sorted LDAP Search Results for usage information about the functions used to perform sorting of entries returned from the server following an LDAP search operation.

Authorities and Locks

No IBM^® i authority is required. All authority checking is done by the LDAP server.

Parameters

sortKeyList

(Input) Specifies the pointer to an array of LDAPsortkey structures, which represent attributes that the server uses to sort returned entries. Input when used for ldap_create_sort_control() and ldap_free_sort_keylist().

Return Value

None.

Example

See the example that uses ldap_create_sort_keylist(), ldap_create_sort_control(), ldap_free_sort_keylist(), and ldap_parse_sort_control() to perform an LDAP sorted search in ldap_create_sort_keylist() --Create a Structure with Sort Key Values used when Sorting Search Results.

Related Information

• ldap_create_sort_keylist() -- Create a structure with sort key values.
• ldap_create_sort_control() -- Create a sorted results control.
• ldap_parse_sort_control() -- Retrieve values in a sorted results control.
• ldap_create_page_control() -- Create a paged results control.
• ldap_parse_page_control() -- Retrieve values in a paged results control.
• ldap_search() -- Asynchronously search the directory.
• ldap_parse_result() -- Extract information from results.

[ Back to top | LDAP APIs | APIs by category ]