Fonction DsReplicaGetInfo2W (ntdsapi.h)

  • Article

La fonction DsReplicaGetInfo2 récupère les données d’état de réplication à partir du service d’annuaire. Cette fonction permet la pagination des résultats dans les cas où il y a plus de 1 000 entrées à récupérer.

Syntaxe

NTDSAPI DWORD DsReplicaGetInfo2W(
  [in]           HANDLE            hDS,
  [in]           DS_REPL_INFO_TYPE InfoType,
  [in, optional] LPCWSTR           pszObject,
  [in, optional] UUID              *puuidForSourceDsaObjGuid,
  [in, optional] LPCWSTR           pszAttributeName,
  [in, optional] LPCWSTR           pszValue,
  [in]           DWORD             dwFlags,
  [in]           DWORD             dwEnumerationContext,
  [out]          VOID              **ppInfo
);

Paramètres

[in] hDS

Contient un handle de service d’annuaire obtenu à partir de la fonction DSBind ou DSBindWithCred .

[in] InfoType

Contient l’une des valeurs DS_REPL_INFO_TYPE qui spécifie le type de données de réplication à récupérer. Cette valeur détermine également le type de structure retourné dans ppInfo.

[in, optional] pszObject

Pointeur vers une chaîne Unicode terminée par null constante qui identifie l’objet pour lequel récupérer les données de réplication. La signification de ce paramètre dépend de la valeur du paramètre InfoType . Voici les codes de valeur possibles.

DS_REPL_INFO_NEIGHBORS

pszObject identifie le contexte de nommage pour lequel les voisins de réplication sont demandés.

DS_REPL_INFO_CURSORS_FOR_NC

pszObject identifie le contexte de nommage pour lequel les curseurs de réplication sont demandés.

DS_REPL_INFO_METADATA_FOR_OBJ

pszObject identifie l’objet pour lequel les métadonnées de réplication sont demandées.

DS_REPL_INFO_KCC_DSA_CONNECT_FAILURES

pszObject doit avoir la valeur NULL.

pszObject doit avoir la valeur NULL.

DS_REPL_INFO_PENDING_OPS

pszObject doit avoir la valeur NULL.

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

pszObject identifie l’objet pour lequel les métadonnées de réplication d’attribut sont demandées.

DS_REPL_INFO_CURSORS_2_FOR_NC

DS_REPL_INFO_CURSORS_3_FOR_NC

DS_REPL_INFO_METADATA_2_FOR_OBJ

pszObject identifie l’objet pour lequel les métadonnées de réplication sont demandées.

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

pszObject identifie l’objet pour lequel les métadonnées de réplication d’attribut sont demandées.

[in, optional] puuidForSourceDsaObjGuid

Pointeur vers une valeur GUID qui identifie une source de réplication spécifique. Si ce paramètre n’a pas la valeur NULL et que le paramètre InfoType contient DS_REPL_INFO_NEIGHBORS, seules les données voisines de la source correspondant à l’objet nTDSDSA avec l’objetGuid donné dans le répertoire sont retournées. Ce paramètre est ignoré si null ou si le paramètre InfoType est autre que DS_REPL_INFO_NEIGHBORS.

[in, optional] pszAttributeName

Pointeur vers une chaîne Unicode terminée par null qui contient le nom de l’attribut spécifique pour lequel récupérer les données de réplication.

Ce paramètre est utilisé uniquement si le paramètre InfoType contient l’une des valeurs suivantes.

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

[in, optional] pszValue

Pointeur vers une chaîne Unicode terminée par null qui contient la valeur de nom unique à correspondre. Si l’attribut demandé est une valeur de type de nom unique, cette fonction retourne les attributs qui contiennent la valeur spécifiée.

[in] dwFlags

Contient un ensemble d’indicateurs qui modifient le comportement de la fonction. Ce paramètre peut être égal à zéro ou à la valeur suivante.

DS_REPL_INFO_FLAG_IMPROVE_LINKED_ATTRS

Oblige les métadonnées d’attribut à prendre en compte les métadonnées sur les valeurs liées de l’attribut. Le vecteur résultant représente les modifications pour tous les attributs. Ce vecteur modifié est utile pour les clients qui s’attendent à ce que tous les attributs et métadonnées soient inclus dans le vecteur de métadonnées d’attribut.

[in] dwEnumerationContext

Contient l’index de l’entrée suivante à récupérer. Ce paramètre doit être défini sur zéro la première fois que cette fonction est appelée.

Ce paramètre est utilisé uniquement si le paramètre InfoType contient l’une des valeurs suivantes.

DS_REPL_INFO_CURSORS_2_FOR_NC

DS_REPL_INFO_CURSORS_3_FOR_NC

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

Cette fonction récupère un maximum de 1 000 entrées sur chaque appel. Si, après l’appel de cette fonction, d’autres entrées sont disponibles, le membre dwEnumerationContext de la structure récupérée contiendra l’index de l’entrée suivante à récupérer. Le membre dwEnumerationContext de la structure récupérée est ensuite utilisé comme paramètre dwEnumerationContext dans l’appel suivant de cette fonction. Une fois toutes les entrées récupérées, le membre dwEnumerationContext de la structure récupérée contient -1. Si -1 est passé pour ce paramètre, cette fonction retourne ERROR_NO_MORE_ITEMS.

[out] ppInfo

Adresse d’un pointeur de structure qui reçoit les données demandées. La valeur du paramètre InfoType détermine le format de cette structure. Pour plus d’informations et une liste des valeurs InfoType possibles et des types de structure correspondants, consultez DS_REPL_INFO_TYPE.

L’appelant doit libérer cette mémoire quand elle n’est plus nécessaire en appelant DsReplicaFreeInfo.

Valeur retournée

Retourne ERROR_SUCCESS en cas de réussite ou une erreur Win32 ou RPC dans le cas contraire. Voici les codes d’erreur possibles.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista
Serveur minimal pris en charge Windows Server 2008
Plateforme cible Windows
En-tête ntdsapi.h
Bibliothèque Ntdsapi.lib
DLL Ntdsapi.dll

Voir aussi

Fonctions de gestion du contrôleur de domaine et de la réplication

DsBind

DsReplicaFreeInfo