DhcpRegisterParamChange, fonction (dhcpcsdk.h)

Article
08/23/2023

La fonction DhcpRegisterParamChange permet aux clients de s’inscrire pour la notification des modifications apportées aux paramètres de configuration DHCP.

Syntaxe

DWORD DhcpRegisterParamChange(
  [in]      DWORD                 Flags,
  [in]      LPVOID                Reserved,
  [in]      LPWSTR                AdapterName,
  [in]      LPDHCPCAPI_CLASSID    ClassId,
  [in]      DHCPCAPI_PARAMS_ARRAY Params,
  [in, out] LPVOID                Handle
);

Paramètres

[in] Flags

Réservé. Doit être défini sur DHCPCAPI_REGISTER_HANDLE_EVENT. S’il n’est pas défini sur cette valeur d’indicateur, l’appel d’API ne réussit pas.

[in] Reserved

Réservé. Doit être défini sur NULL.

[in] AdapterName

GUID de l’adaptateur pour lequel la notification d’événement est demandée. Doit comporter moins de 256 caractères.

[in] ClassId

Réservé. Doit être défini sur NULL.

[in] Params

Paramètres pour lesquels le client souhaite s’inscrire pour la notification, sous la forme d’une structure de DHCPCAPI_PARAMS_ARRAY .

[in, out] Handle

Les attributs de Handle sont déterminés par la valeur des indicateurs. Dans la version 2 de l’API DHCP, les indicateurs doivent être définis sur DHCPCAPI_REGISTER_HANDLE_EVENT. Par conséquent, Handle doit être un pointeur vers une variable HANDLE qui contiendra le handle vers un événement Windows qui est signalé lorsque les paramètres spécifiés dans Params changent. Notez que cette variable HANDLE est utilisée dans un appel ultérieur à la fonction DhcpDeRegisterParamChange pour désinscrire les notifications d’événements associées à cet appel particulier à la fonction DhcpRegisterParamChange .

Valeur retournée

Retourne ERROR_SUCCESS en cas de réussite de l’exécution. Sinon, retourne les codes d’erreur Windows.

Code de retour	Description
ERROR_INVALID_PARAMETER	Retourné si le paramètre AdapterName contient plus de 256 caractères.

Notes

La version 2 de l’API client DHCP fournit uniquement une notification basée sur les événements. Avec la notification basée sur les événements dans DHCP, les clients activent la notification en faisant pointer handle vers une variable qui, une fois le retour réussi, contient les handles EVENT signalés chaque fois que des modifications sont apportées aux paramètres demandés dans Params.

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	dhcpcsdk.h
Bibliothèque	Dhcpcsvc.lib
DLL	Dhcpcsvc.dll

Voir aussi

Fonctions DHCP

DHCPCAPI_PARAMS_ARRAY

DhcpCApiInitialize

DhcpDeRegisterParamChange

Share via