DhcpSetClientInfo function (dhcpsapi.h)

The DhcpSetClientInfo function sets information on a client whose IP address lease is administrated by the DHCP server.

Syntax

DWORD DHCP_API_FUNCTION DhcpSetClientInfo(
  [in] DHCP_CONST WCHAR            *ServerIpAddress,
  [in] DHCP_CONST DHCP_CLIENT_INFO *ClientInfo
);

Parameters

[in] ServerIpAddress

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

[in] ClientInfo

Pointer to a DHCP_CLIENT_INFO structure that contains the information on a client in a subnet served by the DHCP server.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Remarks

This function requires host byte ordering for all DHCP_IP_ADDRESS values in parameter structures.

Requirements

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

See also

DHCP_CLIENT_INFO

DhcpGetClientInfo