DhcpV4CreateClientInfo function (dhcpsapi.h)

The DhcpV4CreateClientInfo function creates a DHCPv4 client lease record in the DHCP server database.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4CreateClientInfo(
  [in, optional] DHCP_CONST WCHAR                 *ServerIpAddress,
  [in]           DHCP_CONST LPDHCP_CLIENT_INFO_PB ClientInfo
);

Parameters

[in, optional] ServerIpAddress

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

[in] ClientInfo

Pointer to a DHCP_CLIENT_INFO_PB structure that contains the DHCP client lease record information. The ClientIpAddress and ClientHardwareAddress fields of this structure are required, all others are optional.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following or an error code from DHCP Server Management API Error Codes.

Remarks

This function does not allow creation of leases if there is no scope corresponding to the ClientIpAddress configured on the server and instead returns ERROR_DHCP_SUBNET_NOT_PRESENT. It marks the specified client IP address as unavailable (or distributed) to avoid IP collisions. The addresses thus marked are also reflected in the scope’s address statistics.

Unlike DhcpCreateClientInfoVQ, this function uses the bClientType, AddressState, Status, ProbationEnds and QuarantineCapable fields passed within the DHCP_CLIENT_INFO_PB structure to ClientInfo when creating the lease record. It also adds the new field PolicyName if passed within ClientInfo in the new lease record. There is no validation of whether the PolicyName corresponds to a valid policy configured on the DHCP server or corresponding scope.

Requirements

See also

DhcpV4GetClientInfo

DhcpV6CreateClientInfo