DhcpEnumFilterV4, fonction (dhcpsapi.h)

  • Article

La fonction DhcpEnumFilterV4 énumère tous les enregistrements de filtre de la liste d’autorisation ou de refus du serveur DHCP.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpEnumFilterV4(
  [in]      DHCP_CONST WCHAR        *ServerIpAddress,
  [in, out] LPDHCP_ADDR_PATTERN     ResumeHandle,
  [in]      DWORD                   PreferredMaximum,
  [in]      DHCP_FILTER_LIST_TYPE   ListType,
  [out]     LPDHCP_FILTER_ENUM_INFO *EnumFilterInfo,
  [out]     DWORD                   *ElementsRead,
  [out]     DWORD                   *ElementsTotal
);

Paramètres

[in] ServerIpAddress

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

[in, out] ResumeHandle

Pointeur vers une structure DHCP_ADDR_PATTERN qui identifie l’opération d’énumération. Initialement, ce paramètre doit être défini sur zéro (0), avec un appel réussi retournant la valeur d’adresse/de modèle utilisée pour les demandes d’énumération suivantes.

[in] PreferredMaximum

Valeur DWORD qui spécifie le nombre maximal d’octets préféré à retourner. Si le nombre d’informations de filtre non chiffrées restantes est inférieur à cette valeur, tous les filtres configurés sur la liste particulière sur le serveur DHCP sont retournés. La valeur maximale est 64 (kilo-octets) et la valeur minimale est 1 (kilo-octet).

[in] ListType

DHCP_FILTER_LIST_TYPE qui spécifie la liste des filtres à énumérer.

[out] EnumFilterInfo

Pointeur vers l’adresse d’un tableau de structures DHCP_FILTER_ENUM_INFO qui contiennent les informations de filtre de couche de liens retournées configurées sur le serveur DHCP.

[out] ElementsRead

Pointeur vers une valeur DWORD qui spécifie le nombre d’entrées de filtre de couche de liens retournées dans EnumFilterInfo.

[out] ElementsTotal

Pointeur vers une valeur DWORD qui spécifie le nombre d’entrées de filtre de couche de liens définies sur le serveur DHCP qui n’ont pas encore été énumérées.

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_ACCESS_DENIED
 Cet appel a été effectué par un client qui n’est pas membre du groupe de sécurité « Administrateurs DHCP ».
ERROR_DHCP_JET_ERROR
 Une erreur s’est produite lors de l’accès à la base de données du serveur DHCP.
ERROR_MORE_DATA
 Il n’y a plus d’éléments disponibles pour l’énumération.
ERROR_NO_MORE_ITEMS
 Il ne reste plus d’éléments à énumérer.

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

DHCP_FILTER_ENUM_INFO

DHCP_FILTER_LIST_TYPE