Edit

Share via

DhcpGetClientOptions function (dhcpsapi.h)

  • Article

The DhcpGetClientOptions function returns only ERROR_NOT_IMPLEMENTED, as it is not used or supported.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetClientOptions(
  [in]  DHCP_CONST WCHAR   *ServerIpAddress,
  [in]  DHCP_IP_ADDRESS    ClientIpAddress,
  [in]  DHCP_IP_MASK       ClientSubnetMask,
  [out] LPDHCP_OPTION_LIST *ClientOptions
);

Parameters

[in] ServerIpAddress

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

[in] ClientIpAddress

DHCP_IP_ADDRESS value that specifies the IP address or hostname of the DHCP client whose option values will be returned.

[in] ClientSubnetMask

DHCP_IP_MASK value that specifies the subnet mask of the DHCP client whose option values will be returned.

[out] ClientOptions

Pointer to a DHCP_OPTION_LIST structure that contains the returned option values for the DHCP client.

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_NOT_IMPLEMENTED
 This function is not implemented and is not supported.

Requirements

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

See also

DHCP_OPTION_LIST