3.1.4.12 R_DhcpRemoveOption (Opnum 11)

The R_DhcpRemoveOption method removes the option definition of a specific option for the default user class and vendor class pair at the default option level. The OptionID parameter specifies the identifier of the option definition.

 DWORD R_DhcpRemoveOption(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in] DHCP_OPTION_ID OptionID
 );

ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.

OptionID: This is of type DHCP_OPTION_ID (section 2.2.1.2.3), containing the option identifier for the option definition being removed.

Return Values: A 32-bit unsigned integer value that indicates return status. A return value ERROR_SUCCESS 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.

0x00004E2A

ERROR_DHCP_OPTION_NOT_PRESENT

The specified option definition does not exist on the DHCP server database.

The opnum field value for this method is 11.

When processing this call, the DHCP server MUST do the following:

  • Validate whether this method is authorized for read/write access per section 3.5.5. If not, return the error ERROR_ACCESS_DENIED.

  • Iterate through the server Abstract Data Model (ADM) element DHCPv4OptionDefList, and retrieve the DHCPv4ClassedOptDefList ADM element corresponding to the DHCPv4OptionDef ADM element entry when the UserClass and VendorClass fields are NULL. If there is no DHCPv4OptionDef ADM element entry whose UserClass and VendorClass fields are NULL, return ERROR_DHCP_CLASS_NOT_FOUND.

  • Iterate through the DHCPv4ClassedOptDefList ADM element, and if there is no DHCPv4ClassedOptDef ADM element entry corresponding to the OptionID parameter, return the error ERROR_DHCP_OPTION_NOT_PRESENT.

  • Delete the DHCPv4ClassedOptDef ADM element entry corresponding to the OptionID parameter from the DHCPv4ClassedOptDefList ADM element. Return ERROR_SUCCESS.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].