Expand Minimize

DhcpRemoveOption function

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

ServerIpAddress [in]

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

OptionID [in]

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

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

DhcpCreateOption
DhcpRemoveOptionV5

 

 

Community Additions

ADD
Show:
© 2014 Microsoft