Edit

Share via

DhcpDeleteSuperScopeV4 function (dhcpsapi.h)

  • Article

The DhcpDeleteSuperScopeV4 function deletes a superscope from the DHCP server.

Syntax

DWORD DhcpDeleteSuperScopeV4(
  [in] DHCP_CONST WCHAR  *ServerIpAddress,
  [in] DHCP_CONST LPWSTR SuperScopeName
);

Parameters

[in] ServerIpAddress

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

[in] SuperScopeName

Unicode string that specifies the name of the superscope to delete.

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_ACCESS_DENIED
 This call was performed by a client who is not a member of the "DHCP Administrators" security group.
ERROR_DHCP_JET_ERROR
 An error occurred while accessing the DHCP server's database.
ERROR_DHCP_SUBNET_NOT_PRESENT
 The specified IPv4 subnet does not exist on the DHCP server.

Remarks

Deleting a superscope does not delete the subnets present in the superscope; it simply removes the table that groups the subnets into a superscope. Individual subnets should be deleted using DhcpDeleteSubnet.

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

See also

DhcpGetSuperScopeInfoV4

DhcpSetSuperScopeV4