DhcpGetOptionValueV5-Funktion (dhcpsapi.h)

Die DhcpGetOptionValueV5-Funktion ruft einen DHCP-Optionswert (den Optionscode und die zugeordneten Daten) für einen bestimmten Bereich ab. Diese Funktion erweitert die von DhcpGetOptionValue bereitgestellte Funktionalität, indem der Aufrufer eine Klasse und/oder einen Anbieter für die Option angeben kann.

Syntax

DWORD DhcpGetOptionValueV5(
  [in]  LPWSTR                   ServerIpAddress,
  [in]  DWORD                    Flags,
  [in]  DHCP_OPTION_ID           OptionID,
  [in]  LPWSTR                   ClassName,
  [in]  LPWSTR                   VendorName,
  [in]  LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [out] LPDHCP_OPTION_VALUE      *OptionValue
);

Parameter

[in] ServerIpAddress

Unicode-Zeichenfolge, die die IP-Adresse oder den Hostnamen des DHCP-Servers angibt.

[in] Flags

Flagwert, der angibt, ob die Option für eine bestimmte Oder Standardanbieterklasse gilt.

Wert	Bedeutung
0x00000000	Der Optionswert wird für eine Standardanbieterklasse abgerufen.
DHCP_FLAGS_OPTION_IS_VENDOR 0x00000003	Der Optionswert wird für eine bestimmte Anbieterklasse abgerufen. Der Anbietername wird in VendorName angegeben.

[in] OptionID

DHCP_OPTION_ID Wert, der den Code für den abzurufenden Optionswert angibt.

[in] ClassName

Unicode-Zeichenfolge, die den DHCP-Klassennamen der Option angibt. Dieser Parameter ist optional.

[in] VendorName

Unicode-Zeichenfolge, die den Anbieter der Option angibt. Dieser Parameter ist optional und sollte NULL sein, wenn Flags nicht auf DHCP_FLAGS_OPTION_IS_VENDOR festgelegt ist. Wenn die Anbieterklasse nicht angegeben wird, wird der Optionswert für die Standardanbieterklasse zurückgegeben.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO Struktur, die Informationen zu dem Bereich enthält, in dem der Optionswert festgelegt ist.

[out] OptionValue

DHCP_OPTION_VALUE Struktur, die den zurückgegebenen Optionscode und die zurückgegebenen Daten enthält.

Hinweis  

Der Arbeitsspeicher für diesen Parameter muss mithilfe von DhcpRpcFreeMemory frei sein.

 

Rückgabewert

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

Rückgabecode	Beschreibung
ERROR_ACCESS_DENIED	Dieser Aufruf wurde von einem Client ausgeführt, der nicht Mitglied der Sicherheitsgruppe "DHCP-Administratoren" ist.
ERROR_DHCP_JET_ERROR	Fehler beim Zugriff auf die Datenbank des DHCP-Servers.
ERROR_DHCP_SUBNET_NOT_PRESENT	Das angegebene IPv4-Subnetz ist auf dem DHCP-Server nicht definiert.
ERROR_DHCP_OPTION_NOT_PRESENT	Die angegebene Optionsdefinition ist in der DHCP-Serverdatenbank nicht vorhanden.
ERROR_DHCP_NOT_RESERVED_CLIENT	Der angegebene DHCP-Client ist kein reservierter Client.

Anforderungen

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

Weitere Informationen

DHCP_OPTION_SCOPE_INFO

DHCP_OPTION_VALUE

DhcpGetOptionValue

DhcpSetOptionValueV5