ldap_search函式 (winldap.h)

發行項
03/13/2024

ldap_search函式會搜尋 LDAP 目錄，並針對每個相符項目傳回要求的一組屬性。

語法

WINLDAPAPI ULONG LDAPAPI ldap_search(
  [in] LDAP   *ld,
  [in] PSTR   base,
  [in] ULONG  scope,
  [in] PSTR   filter,
  [in] PZPSTR attrs,
  [in] ULONG  attrsonly
);

參數

[in] ld

會話句柄。

[in] base

Null 終止字串的指標，其中包含要開始搜尋之項目的辨別名稱。

[in] scope

數據類型，指定下列其中一個值來指出搜尋範圍。

LDAP_SCOPE_BASE

僅搜尋基底專案。

LDAP_SCOPE_ONELEVEL

在基底專案下方的第一層中搜尋所有專案，不包括基底專案。

LDAP_SCOPE_SUBTREE

在基底下方的樹狀結構中搜尋基底專案和所有專案。

[in] filter

指定搜尋篩選之 Null 終止字串的指標。如需詳細資訊，請參閱搜尋篩選語法。

[in] attrs

Null 終止字串的 Null 終止陣列，表示要針對每個相符項目傳回的屬性。傳遞 NULL 以擷取可用的屬性。

[in] attrsonly

如果傳回屬性類型和值，則為零的布爾值，如果只需要型別，則為非零值。

傳回值

如果函式成功，它會傳回搜尋作業的訊息標識碼。

如果函式失敗，它會傳回 –1，並在LDAP數據結構中設定會話錯誤參數。

備註

ldap_search函式會起始異步搜尋作業。

使用 ldap_set_option 函式搭配 ld 會話句柄來設定LDAP_OPT_SIZELIMIT、LDAP_OPT_TIMELIMIT和LDAP_OPT_DEREF選項，以決定搜尋的執行方式。如需詳細資訊，請參閱會話選項。

作為異步函式， ldap_search 傳回作業的訊息標識碼。使用訊息標識符呼叫ldap_result ，以取得作業的結果。若要在完成之前取消異步搜尋作業，請呼叫 ldap_abandon。

若要讓函式直接傳回結果，請使用同步例程 ldap_search_s。使用 ldap_search_ext 或 ldap_search_ext_s 來實作LDAP 3伺服器和用戶端控制的支援。

多線程：呼叫 ldap_search 是安全線程，前提是 LdapGetLastError 用來擷取函式呼叫傳回 -1 失敗碼時的實際會話錯誤碼。

注意連線到LDAP 2 伺服器時，應用程式必須先呼叫其中一個 ldap_bind 或 ldap_simple_bind 例程，再嘗試其他作業，來執行系結作業。

規格需求

需求	值
最低支援的用戶端	Windows Vista
最低支援的伺服器	Windows Server 2008
目標平台	Windows
標頭	winldap.h
程式庫	Wldap32.lib
Dll	Wldap32.dll