DsGetDomainControllerInfoA, fonction (ntdsapi.h)

Article
11/20/2024

La fonction DsGetDomainControllerInfo récupère des données sur les contrôleurs de domaine d’un domaine.

Syntaxe

NTDSAPI DWORD DsGetDomainControllerInfoA(
  [in]  HANDLE hDs,
  [in]  LPCSTR DomainName,
  [in]  DWORD  InfoLevel,
  [out] DWORD  *pcOut,
  [out] VOID   **ppInfo
);

Paramètres

[in] hDs

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

[in] DomainName

Pointeur vers une chaîne terminée par null qui spécifie le nom de domaine.

[in] InfoLevel

Contient une valeur qui indique la version de la structure DS_DOMAIN_CONTROLLER_INFO à retourner. Il peut s’agir de l’une des valeurs suivantes.

1

La fonction fournit les données de domaine au format de structure DS_DOMAIN_CONTROLLER_INFO_1.

2

La fonction fournit les données de domaine au format de structure DS_DOMAIN_CONTROLLER_INFO_2.

3

La fonction fournit les données de domaine au format de structure DS_DOMAIN_CONTROLLER_INFO_3.

[out] pcOut

Pointeur vers une variable DWORD qui reçoit le nombre d’éléments retournés dans tableau ppInfo.

[out] ppInfo

Pointeur vers une variable de pointeur qui reçoit un tableau de structures DS_DOMAIN_CONTROLLER_INFO_*. Le type de structures de ce tableau est défini par le paramètre InfoLevel. L’appelant doit libérer ce tableau, lorsqu’il n’est plus nécessaire, à l’aide de la fonction DsFreeDomainControllerInfo.

Valeur de retour

Si la fonction retourne des données du contrôleur de domaine, la valeur de retour est ERROR_SUCCESS. Si l’appelant n’a pas les privilèges d’accès aux objets serveur, la valeur de retour est ERROR_SUCCESS, mais les structures DS_DOMAIN_CONTROLLER_INFO peuvent être vides.

Si la fonction échoue, la valeur de retour peut être l’un des codes d’erreur suivants.

Remarques

Note

L’en-tête ntdsapi.h définit DsGetDomainControllerInfo comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows Vista
serveur minimum pris en charge	Windows Server 2008
plateforme cible	Windows
d’en-tête	ntdsapi.h
bibliothèque	Ntdsapi.lib
DLL	Ntdsapi.dll