ldap_create_sort_controlW-Funktion (winldap.h)

2024-11-20

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 mit LDAP 3 wirksam, aber ob das Sortiersteuerelement unterstützt wird oder nicht, hängt vom jeweiligen Server ab.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_create_sort_controlW(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPSortKeyW *SortKeys,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlW *Control
);

Parameter

[in] ExternalHandle

Das Sitzungshandle.

[in] SortKeys

Zeigen Sie 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 ob die Sortierreihenfolge aufsteigend oder absteigend ist.

[in] IsCritical

Benachrichtigt den Server darüber, ob dieses Steuerelement für die Suche von entscheidender Bedeutung ist. 0 ==> FALSCH, !0 ==> WAHR.

[out] Control

Zeigen Sie auf das neu erstellte Steuerelement.

Rückgabewert

Diese Funktion gibt WINLDAPAPI ULONG LDAPAPI zurück.

Bemerkungen

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

Mit den Sortiersteuerelementen kann ein Server einen Ergebniscode für die Sortierung der Ergebnisse zurückgeben, die unabhängig vom für den Suchvorgang zurückgegebenen Ergebniscode sind.

Mit dieser Funktion wird das Steuerelement erstellt. Es wird nicht überprüft, ob der Server es unterstützt, und folglich wird keine LDAP_UNAVAILABLE_CRIT_EXTENSION zurückgegeben, wenn der Server das Steuerelement nicht unterstützt. Sie kann jedoch andere Standardmäßige LDAP-Rückgabewerte zurückgeben, z. B. LDAP_NO_MEMORY oder LDAP_PARAM_ERROR.

Rufen Sie ldap_control_freeauf, um das Steuerelement freizurufen, wenn es nicht mehr benötigt wird.

Anmerkung

Der winldap.h-Header definiert ldap_create_sort_control als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows Vista
mindestens unterstützte Server-	Windows Server 2008
Zielplattform-	Fenster
Header-	winldap.h
Library	Wldap32.lib
DLL-	Wldap32.dll

Siehe auch

Freigeben über