DhcpRemoveSubnetElementV5 function (dhcpsapi.h)

Article
10/13/2021

The DhcpRemoveSubnetElementV5 function removes an element from a subnet defined on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpRemoveSubnetElementV5(
  [in, optional] DHCP_CONST WCHAR                       *ServerIpAddress,
  [in]           DHCP_IP_ADDRESS                        SubnetAddress,
  [in]           DHCP_CONST DHCP_SUBNET_ELEMENT_DATA_V5 *RemoveElementInfo,
  [in]           DHCP_FORCE_FLAG                        ForceFlag
);

Parameters

[in, optional] ServerIpAddress

Pointer to a Unicode string that specifies the IP address or hostname of the DHCP server.

[in] SubnetAddress

DHCP_IP_ADDRESS value that specifies the IP address of the subnet gateway and uniquely identifies it.

[in] RemoveElementInfo

DHCP_SUBNET_ELEMENT_DATA_V5 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.

Remarks

This function emulates the RPC interface used by the Windows NT 4.0 DHCP server. It is provided for backward compatibility with older versions of the DHCP Administrator application.

Requirements

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