Fonction DhcpV4GetPolicy (dhcpsapi.h)

Article
02/29/2024

La fonction DhcpV4GetPolicy récupère une stratégie à partir du serveur DHCP.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4GetPolicy(
  [in, optional] LPWSTR          ServerIpAddress,
  [in]           BOOL            fGlobalPolicy,
  [in]           DHCP_IP_ADDRESS SubnetAddress,
  [in]           LPWSTR          PolicyName,
  [out]          LPDHCP_POLICY   *Policy
);

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] fGlobalPolicy

Si true, la stratégie au niveau du serveur est récupérée. Sinon, la stratégie de niveau d’étendue est récupérée.

[in] SubnetAddress

DHCP_IP_ADDRESS structure qui contient l’adresse de sous-réseau IPv4 de la stratégie à récupérer.

[in] PolicyName

Chaîne Unicode terminée par null qui représente le nom de la stratégie à récupérer.

[out] Policy

Pointeur vers une structure DHCP_POLICY qui contient les paramètres de la stratégie demandée dans PolicyName.

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_SUBNET_NOT_PRESENT	Le sous-réseau IPv4 spécifié n’existe pas.
ERROR_DHCP_POLICY_NOT_FOUND	La stratégie de serveur DHCP est introuvable.

Remarques

La stratégie doit être gratuite à 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