DhcpV4AddPolicyRange function (dhcpsapi.h)

The DhcpV4AddPolicyRange function adds an IP address range to a policy.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4AddPolicyRange(
  [in, optional] LPWSTR          ServerIpAddress,
  [in]           DHCP_IP_ADDRESS SubnetAddress,
  [in]           LPWSTR          PolicyName,
  [in]           LPDHCP_IP_RANGE Range
);

Parameters

[in, optional] ServerIpAddress

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

[in] SubnetAddress

DHCP_IP_ADDRESS structure that contains the IPv4 subnet address of the policy IP address range to add.

[in] PolicyName

A null-terminated Unicode string that represents the name of the policy IP address range to add.

[in] Range

A pointer to a DHCP_IP_RANGE structure that contains the policy IP address range to add.

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_DHCP_SUBNET_NOT_PRESENT
The specified IPv4 subnet does not exist.
ERROR_DHCP_POLICY_NOT_FOUND
The specified policy does not exist.
ERROR_DHCP_POLICY_RANGE_EXISTS
The specified policy IP range overlaps with one of the policy IP address ranges specified.
ERROR_DHCP_POLICY_RANGE_BAD
The specified policy IP range is not contained within the IP address range of the scope or the specified policy IP range is not valid.

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

DhcpV4CreatePolicy

DhcpV4DeletePolicy

DhcpV4EnumPolicies

DhcpV4GetPolicy

DhcpV4QueryPolicyEnforcement

DhcpV4RemovePolicyRange

DhcpV4SetPolicy

DhcpV4SetPolicyEnforcement