Edit

DhcpSetClientInfoVQ function (dhcpsapi.h)

  • Article

The DhcpSetClientInfoVQ function sets or modifies an existing DHCP client lease record in the DHCP server record database.

Syntax

DWORD DHCP_API_FUNCTION DhcpSetClientInfoVQ(
  [in] DHCP_CONST WCHAR               *ServerIpAddress,
  [in] DHCP_CONST DHCP_CLIENT_INFO_VQ *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_VQ structure that contains the DHCP client lease record to add to or modify in the DHCP server database.

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 DHCPv6 server's database.
ERROR_DHCP_INVALID_PARAMETER
 The provided client hardware address data is NULL or the length is set to zero, or the subnet mask is incorrect.

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