LDAP_CREATE_RETURN_DELETED_OBJECTS_CONTROL

Edit online

Use the LDAP_CREATE_RETURN_DELETED_OBJECTS_CONTROL API or LDAP routine to create a return deleted objects control.

Synopsis

#include ldap.h

int ldap_create_return_deleted_objects_control(
                       LDAP *ld, 
                       int control_iscritical,
                       LDAPControl **control);

Input parameters

ld
Specifies an LDAP session handle that is returned by a call to ldap_init().
control_iscritical
Specifies whether the control is critical or not. A nonzero value indicates that the return deleted objects control is critical and a zero value if it is not.
control
Specifies the address of a pointer to an LDAPControl structure, where the created control is placed.

Usage

This routine creates a return deleted objects control if the return code is LDAP_SUCCESS. The caller must free the memory that is occupied by the LDAPControl structure after its use.

Errors

  • LDAP_PARAM_ERROR // returned if an invalid parameter was passed
  • LDAP_NO_MEMORY // returned if memory cannot be allocated

See also

LDAP controls