DhcpDeleteSuperScopeV4 function

The DhcpDeleteSuperScopeV4 function deletes a superscope from the DHCP server.

Syntax


DWORD DhcpDeleteSuperScopeV4(
  _In_ DHCP_CONST WCHAR  *ServerIpAddress,
  _In_ DHCP_CONST LPWSTR SuperScopeName
);

Parameters

ServerIpAddress [in]

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

SuperScopeName [in]

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 codeDescription
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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpGetSuperScopeInfoV4
DhcpSetSuperScopeV4

 

 

Show: