DhcpV4QueryPolicyEnforcement function (dhcpsapi.h)
The DhcpV4QueryPolicyEnforcement function retrieves the policy enforcement state on the server or the specified IPv4 subnet from the DHCP Server.
Syntax
DWORD DHCP_API_FUNCTION DhcpV4QueryPolicyEnforcement(
[in, optional] LPWSTR ServerIpAddress,
[in] BOOL fGlobalPolicy,
[in] DHCP_IP_ADDRESS SubnetAddress,
[out] BOOL *Enabled
);
Parameters
[in, optional] ServerIpAddress
Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.
[in] fGlobalPolicy
If TRUE the policy enforcement state of the server is retrieved. Otherwise, the policy enforcement state of specified Ipv4 scope is retrieved.
[in] SubnetAddress
DHCP_IP_ADDRESS structure that contains the IPv4 subnet address of the policy enforcement state to retrieve.
[out] Enabled
Pointer to a BOOL that indicates the state of policy enforcement. If TRUE the policy enforcement state is enabled. Otherwise, the policy enforcement state is disabled.
Return value
If the function succeeds, it returns ERROR_SUCCESS.
If the function fails, it returns one of the following or an error code from DHCP Server Management API Error Codes.
| Value | Meaning |
|---|---|
|
One or more of the parameters were invalid. |
|
The specified IPv4 subnet does not exist. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Target Platform | Windows |
| Header | dhcpsapi.h |
| Library | Dhcpsapi.lib |
| DLL | Dhcpsapi.dll |