DhcpV4SetOptionValues-Funktion (dhcpsapi.h)

Die DhcpV4SetOptionValues-Funktion legt Optionscodes und die zugehörigen Datenwerte für einen bestimmten Bereich fest, der auf dem DHCP-Server definiert ist. Diese Funktion erweitert die von DhcpSetOptionValuesV5 bereitgestellte Funktionalität, indem der Aufrufer eine Richtlinie für die Optionen angeben kann.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4SetOptionValues(
  [in, optional] LPWSTR                    ServerIpAddress,
  [in]           DWORD                     Flags,
  [in, optional] LPWSTR                    PolicyName,
  [in, optional] LPWSTR                    VendorName,
  [in]           LPDHCP_OPTION_SCOPE_INFO  ScopeInfo,
  [in]           LPDHCP_OPTION_VALUE_ARRAY OptionValues
);

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

Reserviert. Muss den Wert 0 (null) haben.

[in, optional] PolicyName

Eine Unicode-Zeichenfolge mit NULL-Beendigung, die den Namen der Richtlinie im Subnetz des festzulegenden 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 wenn NULL, wird der Optionswert für den Standardanbieter festgelegt.

[in] ScopeInfo

Zeiger auf eine DHCP_OPTION_SCOPE_INFO-Struktur , die Informationen enthält, die den DHCP-Bereich der festzulegenden Optionswerte beschreiben. Dieser Parameter gibt an, ob der Optionswert für die Standard-, Server- oder Bereichsebene oder für eine IPv4-Reservierung festgelegt ist.

[in] OptionValues

Zeiger auf eine DHCP_OPTION_VALUE_ARRAY-Struktur , die eine Liste von Optionscodes und den entsprechenden Datenwert enthält, der festgelegt wird.

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.
ERROR_DHCP_NOT_RESERVED_CLIENT	Der angegebene DHCP-Client ist kein reservierter Client.

Hinweise

OptionValues und sein Member Values sollten mithilfe von DhcpRpcFreeMemory kostenlos sein.

Anforderungen

Anforderung	Wert
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

DhcpV4GetOptionValue

DhcpV4RemoveOptionValue

DhcpV4SetOptionValue