ldap_parse_result, fonction (winldap.h)
La fonction ldap_parse_result analyse les réponses du serveur et retourne les champs appropriés.
Syntaxe
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
);
Paramètres
[in] Connection
Handle de session.
[in] ResultMessage
Résultat d’une opération LDAP telle que retournée par l’un des appels d’opération synchrone ou par ldap_result pour une opération asynchrone.
[out, optional] ReturnCode
Indique le résultat de l’opération serveur qui a généré le message de résultat d’origine. Passez la valeur NULL pour ignorer ce champ.
[out, optional] MatchedDNs
Pointeur vers une chaîne large terminée par null. Dans le cas d’un retour de LDAP_NO_SUCH_OBJECT, ce paramètre de résultat est rempli avec un nom unique indiquant la quantité de nom dans la demande qui a été reconnue. Passez la valeur NULL pour ignorer ce champ.
[out, optional] ErrorMessage
Pointeur vers une chaîne large terminée par null qui contient le contenu du champ de message d’erreur du paramètre ResultMessage . Passez la valeur NULL pour ignorer ce champ.
[out, optional] Referrals
Pointeur vers une chaîne large terminée par null qui contient le contenu du champ de références à partir du paramètre ResultMessage , indiquant zéro ou plusieurs autres serveurs LDAP où la demande doit être retentée. Passez la valeur NULL pour ignorer ce champ.
[out, optional] ServerControls
Ce paramètre de résultat est rempli avec un tableau alloué de contrôles copiés à partir du paramètre ResultMessage .
[in] Freeit
Détermine si le paramètre ResultMessage est libéré. Vous pouvez passer n’importe quelle valeur différente de zéro au paramètre Freeit pour libérer le pointeur ResultMessage lorsqu’il n’est plus nécessaire, ou vous pouvez appeler ldap_msgfree pour libérer le résultat ultérieurement.
Valeur retournée
Si la fonction réussit, la valeur de retour est LDAP_SUCCESS.
Si la fonction échoue, elle retourne un code d'erreur. Pour plus d’informations , consultez Valeurs de retour .
Remarques
La fonction ldap_parse_result traverse une chaîne de réponses du serveur à la recherche de messages de résultats à analyser. Utilisez cette fonction si vous souhaitez accéder aux références, aux noms uniques correspondants ou aux contrôles serveur retournés. La fonction ignore les messages de type LDAP_RES_SEARCH_ENTRY et LDAP_RES_SEARCH_REFERENCE.
Quand elles ne sont plus nécessaires, libérez les chaînes ErrorMessage et MatchedDNs en appelant ldap_memfree. Libérez le tableau Références en appelant ldap_value_free. Libérez serverControls en appelant ldap_controls_free.
Configuration requise
| Client minimal pris en charge | Windows Vista |
| Serveur minimal pris en charge | Windows Server 2008 |
| Plateforme cible | Windows |
| En-tête | winldap.h |
| Bibliothèque | Wldap32.lib |
| DLL | Wldap32.dll |