DhcpDeleteClientInfo function

The DhcpDeleteClientInfo function deletes a client information record from the DHCP server.

Syntax


DWORD DHCP_API_FUNCTION DhcpDeleteClientInfo(
  _In_ DHCP_CONST WCHAR            *ServerIpAddress,
  _In_ DHCP_CONST DHCP_SEARCH_INFO *ClientInfo
);

Parameters

ServerIpAddress [in]

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

ClientInfo [in]

DHCP_SEARCH_INFO union structure that contains one of the following items used to search the DHCP client record database: the client IP address, the client MAC address, or the client network name. All records matching the value will be deleted; for example, if a client IP address of 192.1.1.10 is supplied, all records with this address in the ClientIpAddress field will be deleted.

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

Minimum supported client

None supported

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpCreateClientInfo
DHCP_SEARCH_INFO

 

 

Show: