DhcpSetClientInfoV4 function (dhcpsapi.h)

The DhcpSetClientInfoV4 function sets information on a client whose IP address lease is administrated by the DHCP server. This function extends the functionality provided by DhcpSetClientInfo by allowing the caller to specify the client type (DHCP or BOOTP).

Syntax

DWORD DHCP_API_FUNCTION DhcpSetClientInfoV4(
  [in] DHCP_CONST WCHAR               *ServerIpAddress,
  [in] DHCP_CONST DHCP_CLIENT_INFO_V4 *ClientInfo
);

Parameters

[in] ServerIpAddress

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

[in] ClientInfo

Pointer to a DHCP_CLIENT_INFO_V4 structure that contains the information, including client type, for 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.

Return code Description
ERROR_ACCESS_DENIED
This call was performed by a client who is not a member of the "DHCP Administrators" security group.
ERROR_DHCP_JET_ERROR
An error occurred while accessing the DHCP server's database.

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_CLIENT_INFO_V4

DhcpGetClientInfoV4

DhcpSetClientInfo