ldap_first_entry

(PHP 4, PHP 5, PHP 7, PHP 8)

ldap_first_entry最初の結果 ID を返す

説明

ldap_first_entry(LDAP\Connection $ldap, LDAP\Result $result): LDAP\ResultEntry|false

結果内の最初のエントリのエントリ ID を返します。このエントリ ID を ldap_next_entry() に渡し、 結果からそれ以降のエントリを取得します。

LDAP 結果におけるエントリは、ldap_first_entry() および ldap_next_entry() 関数を用いて連続的に 読み込まれます。

パラメータ

ldap

ldap_connect() が返す LDAP\Connection クラスのインスタンス。

result

ldap_list()ldap_search() が返す、LDAP\Result クラスのインスタンス。.

戻り値

成功時に、最初のエントリに関する結果エントリを表す、 LDAP\ResultEntry クラスのインスタンスを返します。 失敗した場合に false を返します

変更履歴

バージョン 説明
8.1.0 引数 ldap は、LDAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース を期待していました。
8.1.0 引数 result は、 LDAP\Result クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース を期待していました。
8.1.0 LDAP\ResultEntry クラスのインスタンスを返すようになりました。 これより前のバージョンでは、リソース を返していました。

参考

関連キーワード:  最初, エントリ, インスタンス, クラス, entry, 期待, バージョン, Result, result, ResultEntry