count_entries Function

This function counts the number of entries in the result set. It can also count the number of entries remaining during a traversal of the result set using a combination of the functions first_entry and next_entry.

Syntax

DBMS_LDAP.count_entries (

ld  IN SESSION,
msg  IN MESSAGE )

RETURN PLS_INTEGER;

Parameters

Table 20-31 count_entry Function Parameters

Parameter	Description
ld (IN)	A valid LDAP session handle
msg (IN)	The search result, as obtained by a call to one of the synchronous search routines

Return Values

Table 20-32 count_entry Function Return Values

Value	Description
PLS INTEGER	Non-zero if there are entries in the result set -1 if there was a problem.

Exceptions

Table 20-33 count_entry Function Exceptions

Exception	Description
invalid_session	Raised if the session handle ld is invalid.
invalid_message	Raised if the incoming msg handle is invalid.
count_entry_error	Raised if there was a problem in counting the entries.

Usage Notes

The count_entries function returns the number of entries contained in a chain of entries. If an error occurs, such as the res parameter being invalid, -1 is returned. The count_entries call can also be used to count the number of entries that remain in a chain if called with a message, entry, or reference returned by first_message, next_message, first_entry, next_entry, first_reference, and next_reference.

See Also: "first_entry Function" "next_entry Function"