The R_DhcpDeleteSuperScopeV4 method deletes the specified superscope from the DHCPv4 server.
DWORD R_DhcpDeleteSuperScopeV4( [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress, [in, ref, string] WCHAR* SuperScopeName );
ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.
SuperScopeName: This is a pointer to WCHAR that points to the name of the superscope that needs to be deleted.
Return Values: A 32-bit unsigned integer value that indicates return status. A return value ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully, else it contains a Win32 error code, as specified in [MS-ERREF]. This error code value can correspond to a DHCP-specific failure, which takes a value between 20000 and 20099, or any generic failure.
|
Return value/code |
Description |
|---|---|
|
0x00000000 ERROR_SUCCESS |
The call was successful. |
|
0x00004E25 ERROR_DHCP_SUBNET_NOT_PRESENT |
The specified IPv4 subnet does not exist on the DHCP server. |
The opnum field value for this method is 38.
When processing this call, the DHCP server MUST do the following:
Validate if this method is authorized for read/write access per section 3.5.5. If not, return the error ERROR_ACCESS_DENIED.
Validate the input superscope name. If the superscope name is NULL, return ERROR_INVALID_PARAMETER.
Retrieve the DHCPv4SuperScope ADM element entry corresponding to the SuperScopeName parameter from the server ADM element DHCPv4SuperScopesList. If the DHCPv4SuperScope ADM element entry is not found, return ERROR_DHCP_SUBNET_NOT_PRESENT.
Delete the DHCPv4SuperScope ADM element entry from the DHCPv4SuperScopesList ADM element.
Iterate through the server ADM element DHCPV4ScopesList. If the DHCPv4Scope.SuperScopeId ADM element is the same as Id of the deleted superscope, modify the DHCPv4Scope.SuperScopeId ADM element to 0 and return ERROR_SUCCESS.
Exceptions Thrown: No exceptions SHOULD be thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].