Extract information from result

# ldap_parse_result

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

ldap_parse_result — Extract information from result

### 说明

function ldap_parse_result(
LDAP\Connection `$ldap`,
LDAP\Result `$result`,
int `&$error_code`,
string `&$matched_dn` = `null`,
string `&$error_message` = `null`,
array `&$referrals` = `null`,
array `&$controls` = `null`
): bool

Parses an LDAP search result.

### 参数

`ldap`

  通过 ldap_connect() 返回的 LDAP\Connection 实例。

`result`

  通过 ldap_list() 或者 ldap_search() 返回的 LDAP\Result 实例。

`error_code`

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

`matched_dn`

  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`.

`error_message`

  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.

`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.

`controls`

  An array of LDAP Controls which have been sent with the response.

### 返回值

成功时返回 `true`， 或者在失败时返回 `false`。

### 更新日志

版本 | 说明
--- | ---
8.1.0 | 现在 `ldap` 参数接受 LDAP\Connection 实例，之前接受有效的 `ldap link` resource。
8.1.0 | The `result` parameter expects an LDAP\Result instance now; previously, a valid `ldap result` resource was expected.
7.3.0 | Support for `controls` added

### 示例

示例 #1 ldap_parse_result() example

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

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open