DhcpRemoveSubnetElement function (dhcpsapi.h)
The DhcpRemoveSubnetElement function removes an IPv4 subnet element from an IPv4 subnet defined on the DHCPv4 server.
Syntax
DWORD DHCP_API_FUNCTION DhcpRemoveSubnetElement(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[in] DHCP_IP_ADDRESS SubnetAddress,
[in] DHCP_CONST DHCP_SUBNET_ELEMENT_DATA *RemoveElementInfo,
[in] DHCP_FORCE_FLAG ForceFlag
);
Parameters
[in] ServerIpAddress
Unicode string that specifies the IP address or hostname of the DHCPv4 server.
[in] SubnetAddress
DHCP_IP_ADDRESS value that specifies the IPv4 address of the subnet gateway from which elements are to be removed.
[in] RemoveElementInfo
DHCP_SUBNET_ELEMENT_DATA structure that contains information used to find the element that will be removed from subnet specified in SubnetAddress.
[in] ForceFlag
DHCP_FORCE_FLAG enumeration value that indicates whether or not the clients affected by the removal of the subnet element should also be deleted.
Return value
This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.
| Return code | Description |
|---|---|
|
An error occurred while accessing the DHCP server database. |
|
The specified IPv4 subnet is not defined on the DHCP server. |
|
The specified DHCP client is a reserved client. |
|
The specified IPv4 address range either overlaps an existing IPv4 address range, or is invalid. |
|
At least one multicast IPv4 address has been leased out to a MADCAP client. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | dhcpsapi.h |
| Library | Dhcpsapi.lib |
| DLL | Dhcpsapi.dll |