Edit

Share via

DhcpGetAllOptionsV6 function (dhcpsapi.h)

  • Article

The DhcpGetAllOptionsV6 function returns an array that contains all options defined on the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetAllOptionsV6(
  [in]  LPWSTR             ServerIpAddress,
  [in]  DWORD              Flags,
  [out] LPDHCP_ALL_OPTIONS *OptionStruct
);

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.

[out] OptionStruct

Pointer to a DHCP_ALL_OPTIONS structure containing every option defined on the DHCP server. If there are no options available on the server, this value will be null.

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