LDAP_GET_ENTRY_CONTROLS(3LDAP) LDAP Library Functions

NAME

ldap_get_entry_controls - get the LDAP controls included with a
directory entry in a set of search results

SYNOPSIS

cc-flag ... file...-lldap [ -library ... ]
#include <ldap.h>

int ldap_get_entry_controls(LDAP *ld, LDAPMessage *entry,
LDAPControl ***serverctrlsp

DESCRIPTION

The ldap_get_entry_controls() function retrieves the LDAP v3 controls
included in a directory entry in a chain of search results. The LDAP
controls are specified in an array of LDAPControl structures. Each
LDAPControl structure represents an LDAP control. The function takes
entry as a parameter, which points to an LDAPMessage structure that
represents an entry in a chain of search results.


The entry notification controls that are used with persistent search
controls are the only controls that are returned with individual
entries. Other controls are returned with results sent from the
server. You can call ldap_parse_result() to retrieve those controls.

ERRORS

ldap_get_entry_controls() returns the following error codes.

LDAP_SUCCESS
LDAP controls were successfully retrieved.


LDAP_DECODING_ERROR
An error occurred when decoding the BER-
encoded message.


LDAP_PARAM_ERROR
An invalid parameter was passed to the
function.


LDAP_NO_MEMORY
Memory cannot be allocated.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+

SEE ALSO

ldap_error(3LDAP), ldap_parse_result(3LDAP), attributes(7)

January 6, 2003
LDAP_GET_ENTRY_CONTROLS(3LDAP)