DhcpV4EnumPolicies 函式 (dhcpsapi.h)

發行項
02/26/2024

DhcpV4EnumPolicies 函式會列舉 DHCP 伺服器上設定的原則。

語法

DWORD DHCP_API_FUNCTION DhcpV4EnumPolicies(
  [in, optional] LPWSTR              ServerIpAddress,
  [in, out]      LPDWORD             ResumeHandle,
  [in]           DWORD               PreferredMaximum,
  [in]           BOOL                fGlobalPolicy,
  [in]           DHCP_IP_ADDRESS     SubnetAddress,
  [out]          LPDHCP_POLICY_ARRAY *EnumInfo,
  [out]          DWORD               *ElementsRead,
  [out]          DWORD               *ElementsTotal
);

參數

[in, optional] ServerIpAddress

Null 終止的 Unicode 字串指標，表示 DHCP 伺服器的 IP 位址或主機名。

[in, out] ResumeHandle

DHCP_RESUME_HANDLE 結構的指標，識別此列舉，以供後續呼叫此函式使用。

一開始，這個值應該在輸入上為零。如果成功，則傳回的值應該用於後續的列舉要求。例如，如果 PreferredMaximum 設定為 100，並在伺服器上設定 200 個原則，可以在擷取前 100 個原則之後使用繼續句柄，在後續呼叫時取得下一個 100。

[in] PreferredMaximum

EnumInfo 中要傳回的原則結構數目上限。如果 PreferredMaximum 大於伺服器上的剩餘非列舉原則數目，則會傳回剩餘的非列舉原則數目。

[in] fGlobalPolicy

如果 為 TRUE ，則會列舉伺服器層級原則。否則會列舉範圍層級原則。

[in] SubnetAddress

DHCP_IP_ADDRESS 結構，其中包含要列舉的原則 IPv4 子網位址。

[out] EnumInfo

包含 DHCP 伺服器上可用原則之DHCP_POLICY_ARRAY 結構的指標。如果未設定任何原則，則此值為 NULL。

[out] ElementsRead

DWORD 的指標，指定 EnumInfo 中傳回的原則數目。

[out] ElementsTotal

DWORD 的指標，指定尚未列舉之 DHCP 伺服器上設定的原則數目。

傳回值

如果函式成功，則會傳回 ERROR_SUCCESS。

如果函式失敗，它會從 DHCP 伺服器管理 API 錯誤碼傳回下列其中一個錯誤碼或錯誤碼。

值	意義
ERROR_MORE_DATA	有更多元素可供列舉。
ERROR_NO_MORE_ITEMS	沒有其他元素可供列舉。

備註

EnumInfo 應該使用 DhcpRpcFreeMemory 免費。

SubnetAddress 必須以主機位元組順序排列。

規格需求

需求	值
最低支援的用戶端	都不支援
最低支援的伺服器	Windows Server 2012 [僅限傳統型應用程式]
目標平台	Windows
標頭	dhcpsapi.h
程式庫	Dhcpsapi.lib
Dll	Dhcpsapi.dll