DhcpV4GetOptionValue-Funktion (dhcpsapi.h)

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

Syntax

DWORD DHCP_API_FUNCTION DhcpV4GetOptionValue(
  [in, optional] LPWSTR                   ServerIpAddress,
  [in]           DWORD                    Flags,
  [in]           DHCP_OPTION_ID           OptionID,
  [in, optional] LPWSTR                   PolicyName,
  [in, optional] LPWSTR                   VendorName,
  [in]           LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [out]          LPDHCP_OPTION_VALUE      *OptionValue
);

Parameter

[in, optional] ServerIpAddress

Zeiger auf eine Unicode-Zeichenfolge mit NULL-Beendigung, die die IP-Adresse oder den Hostnamen des DHCP-Servers darstellt.

[in] Flags

Gibt an, ob die Option für einen bestimmten Oder Standardanbieter gilt.

Flags	Bedeutung
0x00000000	Der Optionswert wird für einen Standardanbieter abgerufen.
DHCP_FLAGS_OPTION_IS_VENDOR 0x00000003	Der Optionswert wird für einen bestimmten Anbieter abgerufen. Der Anbieter befindet sich in VendorName.

[in] OptionID

DHCP_OPTION_ID Struktur, die den eindeutigen Optionscode für den abzurufenden Optionswert angibt. Eine vollständige Liste der Standard-DHCP- und BOOTP-Optionscodes finden Sie unter http://www.ietf.org/rfc/rfc2132.txt

[in, optional] PolicyName

Eine Unicode-Zeichenfolge mit Null-Beendigung, die den Namen der Richtlinie im Subnetz des abzurufenden Optionswerts darstellt. Das Subnetz wird durch das SubnetScopeInfo-Mitglied von ScopeInfo identifiziert.

[in, optional] VendorName

Eine Unicode-Zeichenfolge mit Null-Terminierung, die den Anbieter der Option darstellt. Dieser Parameter ist optional und sollte NULL sein, wenn Flags nicht DHCP_FLAGS_OPTION_IS_VENDOR. Wenn der Anbieter nicht angegeben wird, wird der Optionswert für den Standardanbieter zurückgegeben.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO Struktur, die Informationen zum Bereich des abzurufenden Optionswerts enthält.

[out] OptionValue

Zeiger auf eine DHCP_OPTION_DATA-Struktur , die den Datenwert enthält, der dem durch OptionID angegebenen DHCP-Optionscode entspricht.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie ERROR_SUCCESS zurück.

Wenn die Funktion fehlschlägt, gibt sie einen der folgenden Fehlercodes oder einen Fehlercode aus der DHCP Server Management-API-Fehlercodes zurück.

Wert	Bedeutung
ERROR_INVALID_PARAMETER	Mindestens ein Parameter war ungültig.
ERROR_DHCP_SUBNET_NOT_PRESENT	Das angegebene IPv4-Subnetz ist nicht vorhanden.
ERROR_DHCP_CLASS_NOT_FOUND	Der verwendete Klassenname ist unbekannt oder falsch.
ERROR_DHCP_POLICY_NOT_FOUND	Der angegebene Richtlinienname ist nicht vorhanden.
ERROR_DHCP_OPTION_NOT_PRESENT	Die angegebene Optionsdefinition ist in der DHCP-Serverdatenbank nicht vorhanden.

Hinweise

OptionValue sollte mit DhcpRpcFreeMemory kostenlos sein.

Anforderungen

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

Weitere Informationen

DhcpV4GetAllOptionValues

DhcpV4RemoveOptionValue

DhcpV4SetOptionValue

DhcpV4SetOptionValues