---
name: "ldap_parse_sort_control"
section: "3"
platform: "macos"
package: "OpenLDAP"
version: "561"
release: "macOS 26.5"
platforms: ["linux", "macos"]
url: "https://new.carta.tech/ldap_parse_sort_control"
---

# ldap\_parse\_sort\_control(3)

Decode the information returned from a search operation that used a server-side sort control

## NAME

ldap\_parse\_sort\_control - Decode the information returned from a search operation that used a server-side sort control

## LIBRARY

OpenLDAP LDAP (libldap, -lldap)

## SYNOPSIS

```
#include <ldap.h>
```

**int ldap\_parse\_sort\_control(ld, ctrls, returnCode, attribute)** **LDAP \*ld;** **LDAPControl \*\*ctrls;** **unsigned long \*returnCode;** **char \*\*attribute;**

## DESCRIPTION

**This function is used to parse the results returned in a search operation** **that uses a server-side sort control.**

**It takes a null terminated array of LDAPControl structures usually obtained** **by a call to the**  **ldap\_parse\_result** **function. A returncode which points to the sort control result code,and an array** **of LDAPControl structures that list the client controls to use with the search.** **The function also takes an out parameter** *attribute* **and if the sort operation** **fails, the server may return a string that indicates the first attribute in the** **sortKey list that caused the failure. If this parameter is NULL, no string is** **returned. If a string is returned, the memory should be freed by calling the** **ldap\_memfree function.**

## NOTES

## SEE ALSO

[**ldap\_result**(3)](/ldap_result/3.md), [**ldap\_controls\_free**(3)](/ldap_controls_free/3.md)

## ACKNOWLEDGEMENTS