ldap_create_sort_control-Funktion (winldap.h)

Artikel
03/04/2024

Die ldap_create_sort_control-Funktion wird verwendet, um eine Liste von Sortierschlüsseln in ein Suchsteuerelement zu formatieren. Die Unterstützung für Steuerelemente ist effektiv mit LDAP 3 verfügbar, aber ob das Sortiersteuerelement unterstützt wird oder nicht, hängt vom jeweiligen Server ab.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_create_sort_control(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPSortKeyA *SortKeys,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlA *Control
);

Parameter

[in] ExternalHandle

Das Sitzungshandle.

[in] SortKeys

Zeiger auf ein Array von LDAPSortKey-Strukturen . Jede Struktur im Array gibt den Namen eines Attributs an, das als Sortierschlüssel verwendet werden soll, die übereinstimmende Regel für diesen Schlüssel und gibt an, ob die Sortierreihenfolge aufsteigend oder absteigend ist.

[in] IsCritical

Benachrichtigt den Server, ob dieses Steuerelement für die Suche wichtig ist. 0 ==> FALSE, !0 ==> TRUE.

[out] Control

Zeiger auf das neu erstellte Steuerelement.

Rückgabewert

Diese Funktion gibt WINLDAPAPI ULONG LDAPAPI zurück.

Hinweise

Die ldap_create_sort_control-Funktion erstellt ein grundlegendes Sortiersteuerelement. Ein solches Steuerelement ist nützlich, wenn der LDAP-Client über eingeschränkte Funktionen verfügt und keine Ergebnisse sortieren kann, sie aber sortiert werden muss.

Die Sortiersteuerelemente ermöglichen es einem Server, einen Ergebniscode für die Sortierung der Ergebnisse zurückzugeben, der unabhängig vom für den Suchvorgang zurückgegebenen Ergebniscode ist.

Diese Funktion erstellt das Steuerelement – sie überprüft nicht, ob der Server es unterstützt, und gibt daher keine LDAP_UNAVAILABLE_CRIT_EXTENSION zurück, wenn der Server das Steuerelement nicht unterstützt. Es kann jedoch andere LDAP-Standardrückgabewerte zurückgeben, z. B. LDAP_NO_MEMORY oder LDAP_PARAM_ERROR.

Rufen Sie ldap_control_free auf, um das Steuerelement frei zu geben, wenn es nicht mehr benötigt wird.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista
Unterstützte Mindestversion (Server)	Windows Server 2008
Zielplattform	Windows
Kopfzeile	winldap.h
Bibliothek	Wldap32.lib
DLL	Wldap32.dll

Siehe auch

Freigeben über