DhcpV4SetOptionValue-Funktion (dhcpsapi.h)

Die DhcpV4SetOptionValue-Funktion legt Informationen für einen bestimmten Optionswert auf dem DHCP-Server fest. Diese Funktion erweitert die von DhcpSetOptionValueV5 bereitgestellte Funktionalität, indem der Aufrufer eine Richtlinie für die Option angeben kann.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4SetOptionValue(
  [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,
  [in]           LPDHCP_OPTION_DATA       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 einen Standardanbieter bestimmt ist.

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 festzulegenden Optionswerts darstellt. Das Subnetz wird durch das SubnetScopeInfo-Element von ScopeInfo identifiziert.

[in, optional] VendorName

Eine Unicode-Zeichenfolge mit Null-Termin, 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 ist, wird der Optionswert für den Standardanbieter festgelegt.

[in] ScopeInfo

Zeiger auf eine DHCP_OPTION_SCOPE_INFO Struktur, die Informationen zum Bereich des festzulegenden Optionswerts enthält.

[in] OptionValue

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

Rückgabewert

Wenn die Funktion erfolgreich ist, wird ERROR_SUCCESS zurückgegeben.

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

Wert	Bedeutung
ERROR_INVALID_PARAMETER	Mindestens einer der 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.

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

DhcpV4GetOptionValue

DhcpV4RemoveOptionValue

DhcpV4SetOptionValues