Edit

Share via

DhcpSetOptionValueV6 function (dhcpsapi.h)

  • Article

The DhcpSetOptionValueV6 function sets information for a specific option value on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpSetOptionValueV6(
  [in] LPWSTR                    ServerIpAddress,
  [in] DWORD                     Flags,
  [in] DHCP_OPTION_ID            OptionId,
  [in] LPWSTR                    ClassName,
  [in] LPWSTR                    VendorName,
  [in] LPDHCP_OPTION_SCOPE_INFO6 ScopeInfo,
  [in] LPDHCP_OPTION_DATA        OptionValue
);

Parameters

[in] ServerIpAddress

Pointer to a 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 0.

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 contains the unique option ID number (also called an "option code") of the option being set. Many of these option ID numbers are defined; a complete list of standard DHCP and BOOTP option codes can be found at http://www.ietf.org/rfc/rfc2132.txt.

[in] ClassName

Unicode string that specifies the DHCP class of the option. 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

Pointer to a DHCP_OPTION_SCOPE_INFO6 structure that contains information describing the DHCP scope this option value will be set on.

[in] OptionValue

Pointer to a DHCP_OPTION_DATA structure that contains the data value corresponding to the DHCP option code specified by OptionID.

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_INVALID_PARAMETER
 The parameters were invalid.
ERROR_DHCP_OPTION_NOT_PRESENT
 The specified option is not present on the DHCP server.

Requirements

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