DhcpGetFilterV4 function (dhcpsapi.h)

The DhcpGetFilterV4 function retrieves the enable/disable settings for the DHCPv4 server's allow/deny lists.

Syntax

DWORD DHCP_API_FUNCTION DhcpGetFilterV4(
  [in]  DHCP_CONST WCHAR        *ServerIpAddress,
  [out] DHCP_FILTER_GLOBAL_INFO *GlobalFilterInfo
);

[in] ServerIpAddress

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

[out] GlobalFilterInfo

Pointer to a DHCP_FILTER_GLOBAL_INFO structure that contains the enable/disable settings for the DHCPv6 server's allow/deny lists.

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

Return code	Description
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.

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	dhcpsapi.h
Library	Dhcpsapi.lib
DLL	Dhcpsapi.dll