Edit

DhcpGetOptionInfoV6 function (dhcpsapi.h)

  • Article

The DhcpGetOptionInfoV6 function returns information on a specific DHCP option.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetOptionInfoV6(
  [in]  LPWSTR         ServerIpAddress,
  [in]  DWORD          Flags,
  [in]  DHCP_OPTION_ID OptionID,
  [in]  LPWSTR         ClassName,
  [in]  LPWSTR         VendorName,
  [out] LPDHCP_OPTION  *OptionInfo
);

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 specifies the code for the option to retrieve information on.

[in] ClassName

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

[out] OptionInfo

Pointer to a DHCP_OPTION structure that contains the returned information on the option specified by OptionID.

Note  

The memory for this parameter must be free using DhcpRpcFreeMemory.

 

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_NO_MORE_ITEMS
 No more items to enumerate.
ERROR_NOT_ENOUGH_MEMORY
 Memory failure.
ERROR_MORE_DATA
 More data is available to enumerate.

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