dhcpEnumSubnets 函式 (dhcpsapi.h)

DhcpEnumSubnets 函式會傳回 DHCP 伺服器上定義的子網列舉清單。

語法

DWORD DHCP_API_FUNCTION DhcpEnumSubnets(
  [in]      DHCP_CONST WCHAR   *ServerIpAddress,
  [in, out] DHCP_RESUME_HANDLE *ResumeHandle,
  [in]      DWORD              PreferredMaximum,
  [out]     LPDHCP_IP_ARRAY    *EnumInfo,
  [out]     DWORD              *ElementsRead,
  [out]     DWORD              *ElementsTotal
);

參數

[in] ServerIpAddress

指定 DHCP 伺服器的 IP 位址或主機名稱的 Unicode 字串。

[in, out] ResumeHandle

識別列舉作業 之DHCP_RESUME_HANDLE 值的指標。 一開始，這個值應該是零，且成功呼叫會傳回用於後續列舉要求的控制碼值。 例如，如果 PreferredMaximum 設定為 100，且 200 個子網位址儲存在伺服器上，可以在擷取前 100 個子網之後使用繼續控制碼，以便在後續呼叫時取得下一個 100，依此類推。

[in] PreferredMaximum

指定要傳回的慣用子網位址數目上限。 如果剩餘未分類選項的數目小於此值，則會傳回該數量。

[out] EnumInfo

DHCP_IP_ARRAY結構的指標，其中包含 DHCP 伺服器上可用的子網識別碼。 如果未定義任何子網，這個值將會是 Null。

[out] ElementsRead

DWORD值的指標，指定EnumInfo中傳回的子網位址數目。

[out] ElementsTotal

DWORD值的指標，指定尚未列舉之 DHCP 伺服器上定義的子網數目。

傳回值

此函式會在成功呼叫時 傳回ERROR_SUCCESS 。 如果使用相同的ResumeHandle值進行呼叫，而且已經列舉伺服器上的所有專案，則此方法會傳回ERROR_NO_MORE_ITEMS，並將 ElementsRead和ElementsTotal設定為 0。 否則，它會傳回其中一個 DHCP 伺服器管理 API 錯誤碼。

備註

若不再需要，則應該使用 DhcpRpcFreeMemory釋放列舉資料所耗用的資源，以及內含的所有指標。

此函式需要參數結構中所有 DHCP_IP_ADDRESS 值的主機位元組順序。

需求

最低支援的用戶端	都不支援
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平台	Windows
標頭	dhcpsapi.h
程式庫	Dhcpsapi.lib
Dll	Dhcpsapi.dll

另請參閱

DHCP_IP_ARRAY