modrdn2_s Function

This function modrdn2_s can be used to rename the relative distinguished name of an entry.

Syntax

DBMS_LDAP.modrdn2_s (

ld  IN SESSION,
entrydn  IN VARCHAR2
newrdn  IN VARCHAR2
deleteoldrdn  IN PLS_INTEGER)

RETURN PLS_INTEGER;

Parameters

Table 20-52 modrdn2_s Function Parameters

Parameter	Description
ld (IN)	A valid LDAP session handle.
entrydn (IN)	The distinguished name of the entry. (This entry must be a leaf node in the DIT.).
newrdn (IN)	The new relative distinguished name of the entry.
deleteoldrdn (IN)	A boolean value that if non-zero, indicates that the attribute values from the old name should be removed from the entry.

Return Values

Table 20-53 modrdn2_s Function Return Values

Value	Description
PLS_INTEGER	DBMS_LDAP.SUCCESS if the operation was successful. An exception is raised otherwise.

Exceptions

Table 20-54 modrdn2_s Function Exceptions

Exception	Description
invalid_session	Raised if the session handle ld is invalid.
invalid_entry_dn	Raised if the distinguished name of the entry is invalid.
invalid_rdn	Invalid LDAP RDN.
invalid_deleteoldrdn	Invalid LDAP deleteoldrdn.
general error	For all other errors. The error string associated with this exception explains the error in detail.

Usage Notes

This function can be used to rename the leaf nodes of a DIT. It simply changes the relative distinguished name by which they are known. The use of this function is being deprecated in the LDAP v3 standard. Please use rename_s, which can achieve the same foundation.

See Also: "rename_s Function".