ldap_get_entry_controls

Retrieves LDAP controls from an entry.

LDAP Version:v3
Library:*ldapsdk.*
NDS Version:7.xx or higher
Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

  #include <ldap.h>
  
  int ldap_get_entry_controls (
     LDAP            *ld,
     LDAPMessage     *entry,
     LDAPControl   ***serverctrlsp);

Parameters

ld

(IN) Points to the handle for the LDAP session.

entry

(IN) Points to the entry, returned by the ldap_first_entry or the ldap_next_entry function, from which to extract controls.

serverctrlsp

(OUT) Points to an array of LDAPControl structures copied out of the entry. If this parameter is set to NULL, no controls are returned.

Return Values

0x00

LDAP_SUCCESS

Non-zero

Failure. For a complete list, see LDAP Return Codes.

0x54

LDAP_DECODING_ERROR

0x59

LDAP_PARAM_ERROR

0x5A

LDAP_NO_MEMORY

Remarks

Each LDAPControl structure represents one LDAP v3 server control. When the array of LDAPControl structures is no longer in use, free the memory by calling the ldap_controls_free function.

See Also

ldap_control_free, ldap_controls_free