dhcpV4EnumSubnetReservations 函式 (dhcpsapi.h)

  • 發行項

DhcpV4EnumSubnetReservations 函式會列舉特定 DHCP IPv4 子網的保留。

語法

DWORD DHCP_API_FUNCTION DhcpV4EnumSubnetReservations(
  [in, optional] DHCP_CONST WCHAR              *ServerIpAddress,
  [in]           DHCP_IP_ADDRESS               SubnetAddress,
  [in, out]      DHCP_RESUME_HANDLE            *ResumeHandle,
  [in]           DWORD                         PreferredMaximum,
  [out]          LPDHCP_RESERVATION_INFO_ARRAY *EnumElementInfo,
  [out]          DWORD                         *ElementsRead,
  [out]          DWORD                         *ElementsTotal
);

參數

[in, optional] ServerIpAddress

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

[in] SubnetAddress

DHCP_IP_ADDRESS 結構，其中包含要列舉之保留的 IPv4 子網位址。

[in, out] ResumeHandle

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

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

[in] PreferredMaximum

EnumInfo 中要傳回的子網保留位元組數目上限。 如果 PreferredMaximum 大於伺服器上子網保留的剩餘非列舉位元組數目，則會傳回剩餘的非列舉位元組數目。 若要擷取所有子網保留專案，請將此參數設定為 0xFFFFFFFF。

[out] EnumElementInfo

DHCP_RESERVATION_INFO_ARRAY 結構的指標，其中包含可供指定之子網使用的保留專案。 如果未設定任何項目，這個值會是 NULL。

[out] ElementsRead

DWORD 的指標，指定 EnumElementInfo 中傳回的保留項目數目。

[out] ElementsTotal

DWORD 的指標，指定尚未列舉之 DHCP 伺服器上的保留數目。

傳回值

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

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

值 意義
ERROR_INVALID_PARAMETER
 一或多個參數無效。
ERROR_MORE_DATA
 有更多元素可供列舉。
ERROR_NO_MORE_ITEMS
 沒有其他元素可供列舉。
ERROR_DHCP_SUBNET_NOT_PRESENT
 DHCPv4 伺服器上沒有IPv4子網。

備註

EnumElementInfo 應該使用 DhcpRpcFreeMemory 免費。

規格需求

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