ldap_parse_result-Funktion (winldap.h)

2023-08-27

Die ldap_parse_result-Funktion analysiert Antworten vom Server und gibt die entsprechenden Felder zurück.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_parse_result(
  [in]            LDAP          *Connection,
  [in]            LDAPMessage   *ResultMessage,
  [out, optional] ULONG         *ReturnCode,
  [out, optional] PSTR          *MatchedDNs,
  [out, optional] PSTR          *ErrorMessage,
  [out, optional] PSTR          **Referrals,
  [out, optional] PLDAPControlA **ServerControls,
  [in]            BOOLEAN       Freeit
);

Parameter

[in] Connection

Das Sitzungshandle.

[in] ResultMessage

Das Ergebnis eines LDAP-Vorgangs, der von einem der synchronen Vorgangsaufrufe oder von ldap_result für einen asynchronen Vorgang zurückgegeben wird.

[out, optional] ReturnCode

Gibt das Ergebnis des Servervorgangs an, der die ursprüngliche Ergebnismeldung generiert hat. Übergeben Sie NULL , um dieses Feld zu ignorieren.

[out, optional] MatchedDNs

Ein Zeiger auf eine breite, mit NULL endende Zeichenfolge. Im Falle einer Rückgabe von LDAP_NO_SUCH_OBJECT wird dieser Ergebnisparameter mit einem distinguished Name ausgefüllt, der angibt, wie viel des Namens in der Anforderung erkannt wurde. Übergeben Sie NULL , um dieses Feld zu ignorieren.

[out, optional] ErrorMessage

Ein Zeiger auf eine breite, NULL-endende Zeichenfolge, die den Inhalt des Fehlermeldungsfelds aus dem ResultMessage-Parameter enthält. Übergeben Sie NULL , um dieses Feld zu ignorieren.

[out, optional] Referrals

Ein Zeiger auf eine breite, NULL-endende Zeichenfolge, die den Inhalt des Verweisfelds aus dem ResultMessage-Parameter enthält, der null oder mehr alternative LDAP-Server angibt, auf denen die Anforderung wiederholt werden soll. Übergeben Sie NULL , um dieses Feld zu ignorieren.

[out, optional] ServerControls

Dieser Ergebnisparameter wird mit einem zugeordneten Array von Steuerelementen ausgefüllt, die aus dem ResultMessage-Parameter kopiert wurden.

[in] Freeit

Bestimmt, ob der ResultMessage-Parameter freigegeben wird. Sie können einen beliebigen Wert ungleich null an den Freeit-Parameter übergeben, um den ResultMessage-Zeiger frei zu geben, wenn er nicht mehr benötigt wird, oder Sie können ldap_msgfree aufrufen, um das Ergebnis später frei zu geben.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert LDAP_SUCCESS.

Wenn die Ausführung der Funktion fehlschlägt, wird ein Fehlercode zurückgegeben. Weitere Informationen finden Sie unter Zurückgeben von Werten .

Hinweise

Die ldap_parse_result-Funktion durchläuft eine Kette von Serverantworten und sucht nach Ergebnismeldungen, die analysiert werden sollen. Verwenden Sie diese Funktion, wenn Sie auf die Verweise, den Abgleich von distinguished Names oder zurückgegebenen Serversteuerelementen zugreifen möchten. Die Funktion überspringt Nachrichten vom Typ LDAP_RES_SEARCH_ENTRY und LDAP_RES_SEARCH_REFERENCE.

Wenn sie nicht mehr benötigt werden, geben Sie die Zeichenfolgen ErrorMessage und MatchedDNs frei, indem Sie ldap_memfree aufrufen. Geben Sie das Verweisarray frei, indem Sie ldap_value_free aufrufen. Geben Sie serverControls frei, indem Sie ldap_controls_free aufrufen.

Anforderungen


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