Expand Minimize

DhcpSetFilterV4 function

The DhcpSetFilterV4 function enables or disables the allow and deny lists on a DHCP server.

Syntax


DWORD DHCP_API_FUNCTION WINAPI DhcpSetFilterV4(
  _In_  DHCP_CONST WCHAR *ServerIpAddress,
  _In_  DHCP_FILTER_GLOBAL_INFO *GlobalFilterInfo
);

Parameters

ServerIpAddress [in]

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

GlobalFilterInfo [in]

Pointer to a DHCP_FILTER_GLOBAL_INFO structure that contains information used to enable or disable allow and deny lists.

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_INVALID_PARAMETER

One of the parameters provides an invalid value.

 

Remarks

When filtering is enabled, the DHCP server allows the DHCP clients associated with link-layer addresses in the 'allow' list to be provided with leases, and blocks DHCP clients associated with addresses in the 'deny' list.

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

DHCP_FILTER_GLOBAL_INFO

 

 

Community Additions

ADD
Show:
© 2014 Microsoft