Fonction DhcpV4EnumPolicies (dhcpsapi.h)

Article
02/29/2024

La fonction DhcpV4EnumPolicies énumère les stratégies configurées sur le serveur DHCP.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4EnumPolicies(
  [in, optional] LPWSTR              ServerIpAddress,
  [in, out]      LPDWORD             ResumeHandle,
  [in]           DWORD               PreferredMaximum,
  [in]           BOOL                fGlobalPolicy,
  [in]           DHCP_IP_ADDRESS     SubnetAddress,
  [out]          LPDHCP_POLICY_ARRAY *EnumInfo,
  [out]          DWORD               *ElementsRead,
  [out]          DWORD               *ElementsTotal
);

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, out] ResumeHandle

Pointeur vers une structure de DHCP_RESUME_HANDLE qui identifie cette énumération pour une utilisation dans les appels suivants à cette fonction.

Initialement, cette valeur doit être égale à zéro en entrée. En cas de réussite, la valeur retournée doit être utilisée pour les demandes d’énumération suivantes. Par exemple, si PreferredMaximum est défini sur 100 et que 200 stratégies sont configurées sur le serveur, le handle de reprise d’entreprise peut être utilisé après la récupération des 100 premières stratégies pour obtenir les 100 stratégies suivantes lors d’un appel suivant.

[in] PreferredMaximum

Nombre maximal de structures de stratégie à retourner dans EnumInfo. Si PreferredMaximum est supérieur au nombre de stratégies non énumérées restantes sur le serveur, le nombre restant de stratégies non énumérées est retourné.

[in] fGlobalPolicy

Si la valeur EST TRUE , la stratégie au niveau du serveur est énumérée. Sinon, la stratégie au niveau de l’étendue est énumérée.

[in] SubnetAddress

DHCP_IP_ADDRESS structure qui contient l’adresse de sous-réseau IPv4 des stratégies à énumérer.

[out] EnumInfo

Pointeur vers une structure DHCP_POLICY_ARRAY qui contient les stratégies disponibles sur le serveur DHCP. Si aucune stratégie n’est configurée, cette valeur est NULL.

[out] ElementsRead

Pointeur vers un DWORD qui spécifie le nombre de stratégies retournées dans EnumInfo.

[out] ElementsTotal

Pointeur vers un DWORD qui spécifie le nombre de stratégies configurées sur le serveur DHCP qui n’ont pas encore été énumérées.

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_MORE_DATA	Il existe d’autres éléments disponibles pour énumérer.
ERROR_NO_MORE_ITEMS	Il ne reste plus d’éléments à énumérer.

Remarques

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

SubnetAddress doit être dans l’ordre des octets de l’hôte.

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