LDAP_SERVER_SHOW_DELETED_OID control code

The LDAP_SERVER_SHOW_DELETED_OID control is used with an extended LDAP search function to specify that the search results include any deleted objects that match the search filter.

To use this control, set the members of the LDAPControl structure as follows:

PWCHAR ldctl_oid = LDAP_SERVER_SHOW_DELETED_OID;
struct berval ldctl_value = {0, NULL};
BOOLEAN ldctl_iscritical;

Members

ldctl_oid

LDAP_SERVER_SHOW_DELETED_OID, which is defined as "1.2.840.113556.1.4.417".

ldctl_value

No data for this control. In the berval structure, set bv_len to zero and bv_val to NULL.

ldctl_iscritical

Can be TRUE or FALSE depending on whether the search call is critical to the operation.

Remarks

The Show Deleted control is used with the extended search functions, such as ldap_search_ext, to view deleted objects along with other objects that match the search filter. When an Active Directory object is deleted, a tombstone of the object is preserved in the tombstone container for a configurable period of time known as the garbage collection interval. To view tombstones using the LDAP functions, specify the Show Deleted control. After the garbage collection interval, a tombstone is permanently deleted and can no longer be viewed using this control or otherwise. The relative distinguished name (RDN) of a tombstone is an identifier constructed from the objectGUID of the deleted object. A tombstone has its isDeleted attribute set to TRUE and contains only a subset of the object attributes. For more information, see the description of searchFlags in Characteristics of Attributes.

Requirements

See also

Retrieving Deleted Objects