dhcpsapi.h) (DhcpV4GetPolicy 函数

项目
2024-02-29

DhcpV4GetPolicy 函数从 DHCP 服务器检索策略。

语法

DWORD DHCP_API_FUNCTION DhcpV4GetPolicy(
  [in, optional] LPWSTR          ServerIpAddress,
  [in]           BOOL            fGlobalPolicy,
  [in]           DHCP_IP_ADDRESS SubnetAddress,
  [in]           LPWSTR          PolicyName,
  [out]          LPDHCP_POLICY   *Policy
);

参数

[in, optional] ServerIpAddress

指向以 null 结尾的 Unicode 字符串的指针，该字符串表示 DHCP 服务器的 IP 地址或主机名。

[in] fGlobalPolicy

如果 为 TRUE ，则检索服务器级别策略。否则，将检索范围级别策略。

[in] SubnetAddress

DHCP_IP_ADDRESS 包含要检索的策略的 IPv4 子网地址的结构。

[in] PolicyName

以 null 结尾的 Unicode 字符串，表示要检索的策略的名称。

[out] Policy

指向包含 PolicyName 中请求的策略参数的DHCP_POLICY结构的指针。

返回值

如果函数成功，则返回 ERROR_SUCCESS。

如果函数失败，它将返回以下代码之一或 DHCP 服务器管理 API 错误代码中的错误代码。

值	含义
ERROR_INVALID_PARAMETER	一个或多个参数无效。
ERROR_DHCP_SUBNET_NOT_PRESENT	指定的 IPv4 子网不存在。
ERROR_DHCP_POLICY_NOT_FOUND	找不到 DHCP 服务器策略。

注解

使用DhcpRpcFreeMemory 的策略应是免费的。

要求

要求	值
最低受支持的客户端	无受支持的版本
最低受支持的服务器	Windows Server 2012 [仅限桌面应用]
目标平台	Windows
标头	dhcpsapi.h
Library	Dhcpsapi.lib
DLL	Dhcpsapi.dll