DhcpV4GetPolicy-Funktion (dhcpsapi.h)

Die DhcpV4GetPolicy-Funktion ruft eine Richtlinie vom DHCP-Server ab.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4GetPolicy(
  [in, optional] LPWSTR          ServerIpAddress,
  [in]           BOOL            fGlobalPolicy,
  [in]           DHCP_IP_ADDRESS SubnetAddress,
  [in]           LPWSTR          PolicyName,
  [out]          LPDHCP_POLICY   *Policy
);

Parameter

[in, optional] ServerIpAddress

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

[in] fGlobalPolicy

Wenn TRUE die Richtlinie auf Serverebene abgerufen wird. Andernfalls wird die Richtlinie auf Bereichsebene abgerufen.

[in] SubnetAddress

DHCP_IP_ADDRESS Struktur, die die IPv4-Subnetzadresse der abzurufenden Richtlinie enthält.

[in] PolicyName

Eine Unicode-Zeichenfolge mit NULL-Beendigung, die den Namen der abzurufenden Richtlinie darstellt.

[out] Policy

Zeiger auf eine DHCP_POLICY-Struktur , die die Parameter der in PolicyName angeforderten Richtlinie enthält.

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_POLICY_NOT_FOUND	Die DHCP-Serverrichtlinie wurde nicht gefunden.

Hinweise

Die Richtlinie sollte mit 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

DhcpV4AddPolicyRange

DhcpV4CreatePolicy

DhcpV4DeletePolicy

DhcpV4EnumPolicies

DhcpV4QueryPolicyEnforcement

DhcpV4RemovePolicyRange

DhcpV4SetPolicy

DhcpV4SetPolicyEnforcement