Edit

DhcpV4SetPolicyEnforcement function (dhcpsapi.h)

  • Article

The DhcpV4SetPolicyEnforcement function sets the policy enforcement state of the server or the specified IPv4 subnet on the DHCP Server.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4SetPolicyEnforcement(
  [in, optional] LPWSTR          ServerIpAddress,
  [in]           BOOL            fGlobalPolicy,
  [in]           DHCP_IP_ADDRESS SubnetAddress,
  [in]           BOOL            Enable
);

Parameters

[in, optional] ServerIpAddress

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

[in] fGlobalPolicy

If TRUE the policy enforcement state of the server is set. Otherwise, the policy enforcement state of specified Ipv4 scope is set.

[in] SubnetAddress

DHCP_IP_ADDRESS structure that contains the IPv4 subnet address of the policy enforcement state to set.

[in] Enable

If TRUE the policy enforcement state is enabled. Otherwise, the policy enforcement state is disabled.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following or an error code from DHCP Server Management API Error Codes.

Value Meaning
ERROR_INVALID_PARAMETER
 One or more of the parameters were invalid.
ERROR_DHCP_SUBNET_NOT_PRESENT
 The specified IPv4 subnet does not exist.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DhcpV4AddPolicyRange

DhcpV4CreatePolicy

DhcpV4DeletePolicy

DhcpV4EnumPolicies

DhcpV4GetPolicy

DhcpV4QueryPolicyEnforcement

DhcpV4RemovePolicyRange

DhcpV4SetPolicy