php man page for ldap_parse_result

LDAP_PARSE_RESULT(3)							 1						      LDAP_PARSE_RESULT(3)

ldap_parse_result - Extract information from result

SYNOPSIS
       bool  ldap_parse_result	(resource   $link,  resource  $result, int  &$errcode, [string	&$matcheddn], [string  &$errmsg], [array  &$refer-
       rals])

DESCRIPTION
	Parses an LDAP search result.

PARAMETERS
	      o $link
		- An LDAP link identifier, returned by ldap_connect(3).

	      o $result_identifier
		- An LDAP result resource, returned by ldap_list(3) or ldap_search(3).

	      o $errcode
		- A reference to a variable that will be set to the LDAP error code in the result, or 0 if no error occurred.

	      o $matcheddn
		- A reference to a variable that will be set to a matched DN if one was recognised within the request, otherwise it will be set to
		NULL.

	      o $errmsg
		- A reference to a variable that will be set to the LDAP error message in the result, or an empty string if no error occurred.

	      o $referrals
		- A reference to a variable that will be set to an array set to all of the referral strings in the result, or an empty array if no
		referrals were returned.

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      ldap_parse_result(3) example

	      <?php
	      $result = ldap_search($link, "cn=userref,dc=my-domain,dc=com", "(cn=user*)");
	      $errcode = $dn = $errmsg = $refs =  null;
	      if (ldap_parse_result($link, $result, $errcode, $dn, $errmsg, $refs)) {
		  // do something with $errcode, $dn, $errmsg and $refs
	      }
	      ?>

PHP Documentation Group 												      LDAP_PARSE_RESULT(3)