Edit

DhcpRemoveOption function (dhcpsapi.h)

  • Article

The DhcpRemoveOption function removes the definition of a specific option for the default user class and vendor class at the default option level on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpRemoveOption(
  [in] DHCP_CONST WCHAR *ServerIpAddress,
  [in] DHCP_OPTION_ID   OptionID
);

Parameters

[in] ServerIpAddress

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

[in] OptionID

DHCP_OPTION_ID value that contains the code uniquely identifying the specific option to remove from the DHCP server.

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_DHCP_JET_ERROR
 An error occurred while accessing the DHCP server database.
ERROR_DHCP_OPTION_NOT_PRESENT
 The specified option definition could not be found in the DHCP server database.

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

DhcpCreateOption

DhcpRemoveOptionV5