Edit

Share via

DhcpRemoveOptionValueV5 function (dhcpsapi.h)

  • Article

The DhcpRemoveOptionValueV5 function removes an option value from a scope defined on the DHCP server.

Syntax

DWORD DhcpRemoveOptionValueV5(
  [in] LPWSTR                   ServerIpAddress,
  [in] DWORD                    Flags,
  [in] DHCP_OPTION_ID           OptionID,
  [in] LPWSTR                   ClassName,
  [in] LPWSTR                   VendorName,
  [in] LPDHCP_OPTION_SCOPE_INFO ScopeInfo
);

Parameters

[in] ServerIpAddress

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

[in] Flags

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

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

[in] OptionID

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

[in] ClassName

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

[in] VendorName

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.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO structure that contains information describing the specific scope to remove the option value from.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DHCP_OPTION_SCOPE_INFO

DhcpSetOptionValueV5

DhcpV4RemoveOptionValue