Edit

DhcpRemoveSubnetElementV6 function (dhcpsapi.h)

  • Article

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

Syntax

DWORD DHCP_API_FUNCTION DhcpRemoveSubnetElementV6(
  [in] LPWSTR                        ServerIpAddress,
  [in] DHCP_IPV6_ADDRESS             SubnetAddress,
  [in] LPDHCP_SUBNET_ELEMENT_DATA_V6 RemoveElementInfo,
  [in] DHCP_FORCE_FLAG               ForceFlag
);

Parameters

[in] ServerIpAddress

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

[in] SubnetAddress

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

[in] RemoveElementInfo

DHCP_SUBNET_ELEMENT_DATA_V6 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
ERROR_INVALID_PARAMETER
 The parameters were invalid.
ERROR_FILE_NOT_FOUND
 The specified scope element does not exist.

Requirements

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