Edit

Share via

DhcpGetAllOptionValuesV6 function (dhcpsapi.h)

  • Article

The DhcpGetAllOptionValuesV6 function returns an array that contains all option values defined for a specific scope on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetAllOptionValuesV6(
  [in]  LPWSTR                    ServerIpAddress,
  [in]  DWORD                     Flags,
  [in]  LPDHCP_OPTION_SCOPE_INFO6 ScopeInfo,
  [out] LPDHCP_ALL_OPTION_VALUES  *Values
);

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 options are vendor-specific. If the qualification of vendor options is not necessary, this parameter should be 0.

Value Meaning
DHCP_FLAGS_OPTION_IS_VENDOR
 This flag should be set if vendor-specific options are desired.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO6 structure that contains information on the specific scope whose option values will be returned.

[out] Values

DHCP_ALL_OPTION_VALUES structure that contains the returned option values for the scope specified in ScopeInfo.

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