Fonction DhcpV4GetClientInfo (dhcpsapi.h)

  • Article

La fonction DhcpV4GetClientInfo récupère les informations d’enregistrement de bail du client DHCP à partir de la base de données du serveur DHCP.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4GetClientInfo(
  [in, optional] DHCP_CONST WCHAR            *ServerIpAddress,
  [in]           DHCP_CONST DHCP_SEARCH_INFO *SearchInfo,
  [out]          LPDHCP_CLIENT_INFO_PB       *ClientInfo
);

Paramètres

[in, optional] ServerIpAddress

Pointeur vers une chaîne Unicode terminée par null qui représente l’adresse IP ou le nom d’hôte du serveur DHCP.

[in] SearchInfo

Pointeur vers une structure DHCP_SEARCH_INFO qui définit la clé utilisée pour rechercher l’enregistrement de bail client sur le serveur DHCP.

[out] ClientInfo

Pointeur vers une structure DHCP_CLIENT_INFO_PB qui retourne les informations d’enregistrement de bail du client DHCP.

Valeur retournée

Si la fonction réussit, elle retourne ERROR_SUCCESS.

Si la fonction échoue, elle retourne l’un des codes d’erreur suivants ou un code d’erreur à partir des codes d’erreur de l’API gestion du serveur DHCP.

Valeur Signification
ERROR_INVALID_PARAMETER
 SearchInfo null ou non valide a été passé à la fonction.
ERROR_ACCESS_DENIED
 Cet appel a été effectué par un client qui n’est pas membre des groupes de sécurité Utilisateurs DHCP ou Administrateurs DHCP .
ERROR_DHCP_INVALID_DHCP_CLIENT
 Le client DHCP n’est pas valide. Dans ce cas, les informations de recherche transmises n’avaient pas d’enregistrements de bail IPv4 correspondants.

Remarques

Si le membre SearchType de la structure passée à SearchInfo est DhcpClientName et qu’il existe plusieurs enregistrements de bail avec les mêmes noms d’hôte client, l’enregistrement de bail retourné est indéterminé.

ClientInfo doit être gratuit à l’aide de DhcpRpcFreeMemory.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Aucun pris en charge
Serveur minimal pris en charge Windows Server 2012 [applications de bureau uniquement]
Plateforme cible Windows
En-tête dhcpsapi.h
Bibliothèque Dhcpsapi.lib
DLL Dhcpsapi.dll

Voir aussi

DhcpV4CreateClientInfo

DhcpV4GetClientInfo

DhcpV6CreateClientInfo