DhcpCreateClientInfoVQ function

The DhcpCreateClientInfoVQ function creates the provided DHCP client lease record in the DHCP server database.

Syntax


DWORD WINAPI DhcpCreateClientInfoVQ(
  _In_ DHCP_CONST WCHAR      *ServerIpAddress,
  _In_ LPDHCP_CLIENT_INFO_VQ ClientInfo
);

Parameters

ServerIpAddress [in]

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

ClientInfo [in]

Pointer to a DHCP_CLIENT_INFO_VQ structure that contains the DHCP client lease record information to set on the DHCP server. The caller must populate the ClientIPAddress and ClientHardwareAddress fields of this structure; all others are optional.

Return value

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

Return codeDescription
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.

ERROR_DHCP_CLIENT_EXISTS

The provided DHCP client record already exists in the DHCP server database.

 

Remarks

Additionally, this API marks the specified client IP address as unavailable (or distributed) to avoid IP collisions.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpSetClientInfoVQ

 

 

Show: