Expand Minimize

DhcpAddFilterV4 function

The DhcpAddFilterV4 function adds a link-layer address or address pattern to the allow/deny lists.

Syntax


DWORD WINAPI DhcpAddFilterV4(
  _In_  DHCP_CONST WCHAR *ServerIpAddress,
  _In_  DHCP_FILTER_ADD_INFO *AddFilterInfo,
  _In_  BOOL ForceFlag
);

Parameters

ServerIpAddress [in]

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

AddFilterInfo [in]

Pointer to a DHCP_FILTER_ADD_INFO structure that contains a link-layer address or address pattern to add to the DHCP server's allow/deny list.

ForceFlag [in]

If TRUE, any existing matching filter is overwritten; if FALSE, the call fails with ERROR_DHCP_LINKLAYER_ADDRESS_EXISTS.

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_LINKLAYER_ADDRESS_EXISTS

The address or address pattern already exists in an allow/deny list.

 

Remarks

This API allows DHCP clients whose addresses have been added to the allow list to obtain leases, and blocks those added to the deny list. The respective lists must be enabled with a call to DhcpSetFilterV4.

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

DhcpSetFilterV4
DHCP_FILTER_ADD_INFO

 

 

Community Additions

ADD
Show:
© 2014 Microsoft