first_entry Function

This function retrieves the first entry in the result set returned by either search_s or search_st

Syntax

DBMS_LDAP.first_entry (

ld  IN SESSION,
msg  IN MESSAGE )

RETURN MESSAGE;

Parameters

Table 20-25 first_entry Function Parameters

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

Return Values

Table 20-26 first_entry Return Values

Value	Description
MESSAGE	A handle to the first entry in the list of entries returned from the LDAP server. It is set to NULL if there was an error and an exception is raised.

Exceptions

Table 20-27 first_entry Exceptions

Exception	Description
invalid_session	Raised if the session handle ld is invalid.
invalid_message	Raised if the incoming msg handle is invalid.

Usage Notes

The function first_entry should always be the first function used to retrieve the results from a search operation.

See Also: "next_entry Function" "search_s Function" "search_st Function"