compare_s Function

This function tests whether a particular attribute in a particular entry has a particular value.

Syntax

DBMS_LDAP.compare_s (

ld  IN SESSION,
dn  IN VARCHAR2,
attr  IN VARCHAR2,
value  IN VARCHAR2)

RETURN PLS_INTEGER;

Parameters

Table 20-16 compare_s Function Parameters

Parameter	Description
ld (IN)	A valid LDAP session handle
dn (IN)	The name of the entry to compare against
attr (IN)	The attribute to compare against.
value (IN)	A string attribute value to compare against

Return Values

Table 20-17 compare_s Function Return Values

Value	Description
PLS_INTEGER	COMPARE_TRUE is the given attribute that has a matching value. COMPARE_FALSE if the value of the attribute does not match the value given.

Exceptions

Table 20-18 compare_s Function Exceptions

Exception	Description
invalid_session	Raised if the session handle ld is invalid.
general_error	For all other errors. The error string associated with this exception explains the error in detail.

Usage Notes

The function compare_s can be used to assert if the value of a given attribute stored in the directory server matches a certain value.This operation can only be performed on attributes whose syntax definition allows them to be compared. The compare_s function can only be called after a valid LDAP session handle has been obtained from the init function and authenticated using the bind_s or simple_bind_s functions.

See Also: "bind_s Function".