Skip to content

Latest commit

 

History

History
119 lines (97 loc) · 2.97 KB

nf-dhcpsapi-dhcpdeletesuperscopev4.md

File metadata and controls

119 lines (97 loc) · 2.97 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dhcpsapi.DhcpDeleteSuperScopeV4
DhcpDeleteSuperScopeV4 function (dhcpsapi.h)
Deletes a superscope from the DHCP server.
DhcpDeleteSuperScopeV4
DhcpDeleteSuperScopeV4 function [DHCP]
dhcp.dhcpdeletesuperscopev4
dhcpsapi/DhcpDeleteSuperScopeV4
dhcp\dhcpdeletesuperscopev4.htm
DHCP
5d61f39d-8423-43c4-89ab-4c28214ee84d
12/05/2018
DhcpDeleteSuperScopeV4, DhcpDeleteSuperScopeV4 function [DHCP], dhcp.dhcpdeletesuperscopev4, dhcpsapi/DhcpDeleteSuperScopeV4
dhcpsapi.h
Windows
None supported
Windows Server 2008 R2 [desktop apps only]
Dhcpsapi.lib
Dhcpsapi.dll
Windows
19H1
DhcpDeleteSuperScopeV4
dhcpsapi/DhcpDeleteSuperScopeV4
c++
APIRef
kbSyntax
DllExport
Dhcpsapi.dll
DhcpDeleteSuperScopeV4

DhcpDeleteSuperScopeV4 function

-description

The DhcpDeleteSuperScopeV4 function deletes a superscope from the DHCP server.

-parameters

-param ServerIpAddress [in]

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

-param SuperScopeName [in]

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

-returns

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.

-see-also

DhcpGetSuperScopeInfoV4

DhcpSetSuperScopeV4