DhcpEnumSubnetElements-Funktion (dhcpsapi.h)

Die DhcpEnumSubnetElements-Funktion gibt eine enumerierte Liste von Elementen für ein bestimmtes DHCP-Subnetz zurück.

Syntax

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
);

Parameter

[in] ServerIpAddress

Unicode-Zeichenfolge, die die IPv4-Adresse des DHCP-Servers angibt.

[in] SubnetAddress

DHCP_IP_ADDRESS Wert, der die Adresse des IPv4-Subnetzes angibt, dessen Elemente aufgelistet werden.

[in] EnumElementType

DHCP_SUBNET_ELEMENT_TYPE Enumerationswert, der den Typ des zu enumerierenden Subnetzelements angibt.

[in, out] ResumeHandle

Zeiger auf einen DHCP_RESUME_HANDLE Wert, der den Enumerationsvorgang identifiziert. Zunächst sollte dieser Wert null sein, wobei ein erfolgreicher Aufruf den handle-Wert zurückgibt, der für nachfolgende Enumerationsanforderungen verwendet wird. Wenn beispielsweise PreferredMaximum auf 1000 Bytes festgelegt ist und Subnetzelemente im Wert von 2000 Bytes auf dem Server gespeichert sind, kann das Resume-Handle verwendet werden, nachdem die ersten 1000 Bytes abgerufen wurden, um die nächsten 1000 bei einem nachfolgenden Aufruf abzurufen usw.

Das Vorhandensein zusätzlicher aufzählbarer Daten wird angegeben, wenn diese Funktion ERROR_MORE_DATA zurückgibt. Wenn auf dem DHCPv4-Server keine zusätzlichen aufzählbaren Daten verfügbar sind, wird ERROR_NO_MORE_ITEMS zurückgegeben.

[in] PreferredMaximum

Gibt die bevorzugte maximale Anzahl von Bytes an Subnetzelementen an, die zurückgegeben werden sollen. Wenn die Anzahl der verbleibenden nicht aufgelisteten Optionen (in Bytes) kleiner als dieser Wert ist, wird dieser Betrag zurückgegeben.

Um alle Subnetzclientelemente für die Standardbenutzer- und Anbieterklasse auf der angegebenen Ebene abzurufen, legen Sie diesen Parameter auf 0xFFFFFFFF fest.

[out] EnumElementInfo

Zeiger auf einen Zeiger auf eine DHCP_SUBNET_ELEMENT_INFO_ARRAY-Struktur , die eine liste aller für das angegebene Subnetz verfügbaren Elemente enthält. Wenn keine Elemente für die Enumeration verfügbar sind, ist dieser Wert NULL.

[out] ElementsRead

Zeiger auf einen DWORD-Wert, der die Anzahl der Subnetzelemente angibt, die in EnumElementInfo zurückgegeben werden.

[out] ElementsTotal

Zeiger auf einen DWORD-Wert, der die Gesamtzahl der noch nicht auf dem Server verbleibenden Elemente für das angegebene Subnetz angibt.

Rückgabewert

Diese Funktion gibt bei einem erfolgreichen Aufruf ERROR_SUCCESS zurück. Andernfalls wird einer der Fehlercodes der DHCP-Serververwaltungs-API zurückgegeben.

Rückgabecode	Beschreibung
ERROR_DHCP_JET_ERROR	Fehler beim Zugriff auf die DHCP-Serverdatenbank.
ERROR_MORE_DATA	Es stehen weitere Elemente zum Aufzählen zur Verfügung.
ERROR_NO_MORE_ITEMS	Es sind keine weiteren Elemente mehr zu enumerieren.
ERROR_DHCP_SUBNET_NOT_PRESENT	Das angegebene IPv4-Subnetz ist auf dem DHCP-Server nicht vorhanden.

Anforderungen

Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	dhcpsapi.h
Bibliothek	Dhcpsapi.lib
DLL	Dhcpsapi.dll

Weitere Informationen

DHCP_SUBNET_ELEMENT_INFO_ARRAY

DHCP_SUBNET_ELEMENT_TYPE

DhcpEnumSubnetElementsV4

DhcpEnumSubnetElementsV5