Expand Minimize

DhcpRemoveOptionV6 function

The DhcpRemoveOptionV6 function removes an option defined on the DHCP server..

Syntax


DWORD DhcpRemoveOptionV6(
  _In_  LPWSTR ServerIpAddress,
  _In_  DWORD Flags,
  _In_  DHCP_OPTION_ID OptionID,
  _In_  WCHAR *ClassName,
  _In_  WCHAR *VendorName
);

Parameters

ServerIpAddress [in]

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

Flags [in]

Specifies a bit flag that indicates whether or not the option is vendor-specific. If it is not, this parameter should be 0.

ValueMeaning
DHCP_FLAGS_OPTION_IS_VENDOR

This flag should be set if the option is provided by a vendor.

 

OptionID [in]

DHCP_OPTION_ID value that specifies the code for the option to remove.

ClassName [in]

Unicode string that specifies the DHCP class name of the option. This parameter is optional.

VendorName [in]

Unicode string that specifies the vendor of the option. This parameter is optional, and should be NULL when Flags is not set to DHCP_FLAGS_OPTION_IS_VENDOR.

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_INVALID_PARAMETER

The parameters were invalid.

ERROR_DHCP_OPTION_NOT_PRESENT

The specified option is not present on the DHCP server.

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft