DhcpGetAllOptions, fonction (dhcpsapi.h)

La fonction DhcpGetAllOptions retourne un tableau qui contient toutes les options définies sur le serveur DHCP.

Syntaxe

DWORD DhcpGetAllOptions(
  [in]  LPWSTR             ServerIpAddress,
  [in]  DWORD              Flags,
  [out] LPDHCP_ALL_OPTIONS *OptionStruct
);

Paramètres

[in] ServerIpAddress

Chaîne Unicode qui spécifie l’adresse IP ou le nom d’hôte du serveur DHCP.

[in] Flags

Spécifie un indicateur de bits qui indique si les options sont spécifiques au fournisseur. Si la qualification des options de fournisseur n’est pas nécessaire, ce paramètre doit être 0.

Valeur Signification
DHCP_FLAGS_OPTION_IS_VENDOR
Cet indicateur doit être défini si des options spécifiques au fournisseur sont souhaitées.

[out] OptionStruct

Pointeur vers une structure DHCP_ALL_OPTIONS contenant chaque option définie pour un fournisseur ou une classe par défaut. Si aucune option n’est disponible sur le serveur, cette valeur est null.

Remarque  

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

 

Valeur retournée

Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Sinon, elle retourne l’un des codes d’erreur de l’API Gestion du serveur DHCP.

Code de retour Description
ERROR_DHCP_JET_ERROR
Une erreur s’est produite lors de l’accès à la base de données du serveur DHCP.

Notes

Il y aura un élément d’option dans le tableau spécifié par OptionStruct pour chaque paire fournisseur/classe définie sur le serveur DHCP.

Spécifications

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

Voir aussi

DhcpGetAllOptionValues