Fonction DhcpV4FailoverGetClientInfo (dhcpsapi.h)

  • Article

La fonction DhcpV4FailoverGetClientInfo récupère les informations de bail du client DHCPv4.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4FailoverGetClientInfo(
  [in, optional] LPWSTR                        ServerIpAddress,
  [in]           DHCP_CONST DHCP_SEARCH_INFO   *SearchInfo,
  [out]          LPDHCPV4_FAILOVER_CLIENT_INFO *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 DHCPv4 sur le serveur. Si le membre SearchType de SearchInfo est DhcpClientName et qu’il existe plusieurs enregistrements de bail portant le même nom de client, le serveur retourne les informations du client avec l’adresse IP numérique la plus faible.

[out] ClientInfo

Pointeur vers une structure DHCPV4_FAILOVER_CLIENT_INFO qui contient l’enregistrement de bail client DHCPv4 récupéré.

Remarque  

La mémoire de ce paramètre doit être libre à l’aide de DhcpRpcFreeMemory.

 

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
 Un ou plusieurs des paramètres n’étaient pas valides.
ERROR_DHCP_JET_ERROR
 Une erreur s’est produite lors de l’accès à la base de données du serveur DHCP ou l’entrée du client n’est pas présente dans la base de données.

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