Fonction DhcpEnumSubnetElements (dhcpsapi.h)
La fonction DhcpEnumSubnetElements retourne une liste énumérée d’éléments pour un sous-réseau DHCP spécifique.
Syntaxe
DWORD DHCP_API_FUNCTION DhcpEnumSubnetElements(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[in] DHCP_IP_ADDRESS SubnetAddress,
[in] DHCP_SUBNET_ELEMENT_TYPE EnumElementType,
[in, out] DHCP_RESUME_HANDLE *ResumeHandle,
[in] DWORD PreferredMaximum,
[out] LPDHCP_SUBNET_ELEMENT_INFO_ARRAY *EnumElementInfo,
[out] DWORD *ElementsRead,
[out] DWORD *ElementsTotal
);
Paramètres
[in] ServerIpAddress
Chaîne Unicode qui spécifie l’adresse IPv4 du serveur DHCP.
[in] SubnetAddress
DHCP_IP_ADDRESS valeur qui spécifie l’adresse du sous-réseau IPv4 dont les éléments seront énumérés.
[in] EnumElementType
DHCP_SUBNET_ELEMENT_TYPE valeur d’énumération qui indique le type d’élément de sous-réseau à énumérer.
[in, out] ResumeHandle
Pointeur vers une valeur DHCP_RESUME_HANDLE qui identifie l’opération d’énumération. Initialement, cette valeur doit être égale à zéro, un appel réussi retournant la valeur de handle utilisée pour les demandes d’énumération suivantes. Par exemple, si PreferredMaximum est défini sur 1000 octets et que 2 000 octets d’éléments de sous-réseau sont stockés sur le serveur, le handle de cv peut être utilisé après que les 1 000 premiers octets ont été récupérés pour obtenir les 1000 suivants lors d’un appel suivant, et ainsi de suite.
La présence de données énumérables supplémentaires est indiquée lorsque cette fonction retourne ERROR_MORE_DATA. Si aucune donnée énumérable supplémentaire n’est disponible sur le serveur DHCPv4, ERROR_NO_MORE_ITEMS est retourné.
[in] PreferredMaximum
Spécifie le nombre maximal d’octets d’éléments de sous-réseau à retourner. Si le nombre d’options non chiffrées restantes (en octets) est inférieur à cette valeur, ce montant est retourné.
Pour récupérer tous les éléments clients de sous-réseau pour la classe d’utilisateur et de fournisseur par défaut au niveau spécifié, définissez ce paramètre sur 0xFFFFFFFF.
[out] EnumElementInfo
Pointeur vers un pointeur vers une structure DHCP_SUBNET_ELEMENT_INFO_ARRAY contenant une liste énumérée de tous les éléments disponibles pour le sous-réseau spécifié. Si aucun élément n’est disponible pour l’énumération, cette valeur est null.
[out] ElementsRead
Pointeur vers une valeur DWORD qui spécifie le nombre d’éléments de sous-réseau retournés dans EnumElementInfo.
[out] ElementsTotal
Pointeur vers une valeur DWORD qui spécifie le nombre total d’éléments non chiffrés restant sur le serveur pour le sous-réseau spécifié.
Valeur retournée
Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Sinon, il retourne l’un des codes d’erreur de l’API gestion du serveur DHCP.
| Code de retour | Description |
|---|---|
|
Une erreur s’est produite lors de l’accès à la base de données du serveur DHCP. |
|
Il existe d’autres éléments disponibles pour énumérer. |
|
Il ne reste plus d’éléments à énumérer. |
|
Le sous-réseau IPv4 spécifié n’existe pas sur le serveur DHCP. |
Spécifications
| Client minimal pris en charge | Aucun pris en charge |
| Serveur minimal pris en charge | Windows 2000 Server [applications de bureau uniquement] |
| Plateforme cible | Windows |
| En-tête | dhcpsapi.h |
| Bibliothèque | Dhcpsapi.lib |
| DLL | Dhcpsapi.dll |
Voir aussi
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour