DhcpEnumSubnetElementsV4 函式 (dhcpsapi.h)

  • 發行項

DhcpEnumSubnetElementsV4函式會傳回特定 DHCP 子網的元素列舉清單。 此函式會藉由傳回DHCP_SUBNET_ELEMENT_DATA_V4結構清單來擴充DhcpEnumSubnetElements，其可包含以用戶端類型為基礎的 IP 保留專案。

語法

DWORD DHCP_API_FUNCTION DhcpEnumSubnetElementsV4(
  [in]      DHCP_CONST WCHAR                    *ServerIpAddress,
  [in]      DHCP_IP_ADDRESS                     SubnetAddress,
  [in]      DHCP_SUBNET_ELEMENT_TYPE            EnumElementType,
  [in, out] DHCP_RESUME_HANDLE                  *ResumeHandle,
  [in]      DWORD                               PreferredMaximum,
  [out]     LPDHCP_SUBNET_ELEMENT_INFO_ARRAY_V4 *EnumElementInfo,
  [out]     DWORD                               *ElementsRead,
  [out]     DWORD                               *ElementsTotal
);

參數

[in] ServerIpAddress

指定 DHCPv4 伺服器的 IPv4 位址的 Unicode 字串。

[in] SubnetAddress

DHCP_IP_ADDRESS 值，指定將列舉其專案之 IPv4 子網的位址。

[in] EnumElementType

DHCP_SUBNET_ELEMENT_TYPE 列舉值，指出要列舉的子網元素類型。

[in, out] ResumeHandle

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

當此函式傳回ERROR_MORE_DATA時，會指出是否有其他可列舉的資料。 如果 DHCPv4 伺服器上沒有額外的可列舉資料，則會傳回ERROR_NO_MORE_ITEMS。

[in] PreferredMaximum

指定要傳回之子網元素慣用的最大位元組數目。 如果剩餘未分類的選項數目 (位元組) 小於此值，則會傳回該數量。

若要擷取指定層級上預設使用者和廠商類別的所有子網用戶端元素，請將此參數設定為0xFFFFFFFF。

[out] EnumElementInfo

DHCP_SUBNET_ELEMENT_INFO_ARRAY_V4結構的指標，其中包含指定之子網可用之所有專案的列舉清單。 如果沒有專案可用於列舉，這個值會是 Null。

[out] ElementsRead

DWORD 值的指標，指定 EnumElementInfo中傳回的子網元素數目。

[out] ElementsTotal

DWORD 值的指標，這個值會指定伺服器上剩餘指定子網之尚未匯總元素的總數。

傳回值

此函式會在成功呼叫時 傳回ERROR_SUCCESS 。 否則，它會傳回其中一個 DHCP 伺服器管理 API 錯誤碼。

傳回碼 描述
ERROR_DHCP_JET_ERROR
 存取 DHCP 伺服器資料庫時發生錯誤。
ERROR_MORE_DATA
 有更多元素可供列舉。
ERROR_NO_MORE_ITEMS
 沒有其他元素可供列舉。
ERROR_DHCP_SUBNET_NOT_PRESENT
 DHCP 伺服器上沒有指定的 IPv4 子網。

需求

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

另請參閱

DHCP_SUBNET_ELEMENT_INFO_ARRAY_V4

DHCP_SUBNET_ELEMENT_TYPE

DhcpEnumSubnetElements

DhcpEnumSubnetElementsV5