DhcpV4FailoverEnumRelationship 函式 (dhcpsapi.h)

  • 發行項

DhcpV4FailoverEnumRelationship函式會列舉伺服器上存在的所有容錯移轉關聯性。

語法

DWORD DHCP_API_FUNCTION DhcpV4FailoverEnumRelationship(
  [in, optional] LPWSTR                             ServerIpAddress,
  [in, out]      DHCP_RESUME_HANDLE                 *ResumeHandle,
  [in]           DWORD                              PreferredMaximum,
  [out]          LPDHCP_FAILOVER_RELATIONSHIP_ARRAY *pRelationship,
  [out]          LPDWORD                            RelationshipRead,
  [out]          LPDWORD                            RelationshipTotal
);

參數

[in, optional] ServerIpAddress

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

[in, out] ResumeHandle

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

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

[in] PreferredMaximum

在 pRelationship中傳回的容錯移轉關聯性專案數目上限。 如果 PreferredMaximum 大於伺服器上剩餘的非列舉原則數目，則會傳回其餘的非列舉原則數目。

[out] pRelationship

DHCP_FAILOVER_RELATIONSHIP_ARRAY結構的指標，其中包含 DHCP 伺服器上可用的容錯移轉關聯性陣列。 如果未設定任何關聯性， 則此值為 Null。

[out] RelationshipRead

DWORD的指標，指定pRelationship中傳回的容錯移轉關聯性專案數目。

[out] RelationshipTotal

DWORD的指標，指定尚未列舉之 DHCP 伺服器上設定的容錯移轉關聯性數目。

傳回值

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

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

值 意義
ERROR_INVALID_PARAMETER
 一或多個參數無效。
ERROR_MORE_DATA
 有更多專案可供列舉。
ERROR_NO_MORE_ITEMS
 沒有其他元素可供列舉。

需求

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

另請參閱

DhcpV4FailoverCreateRelationship

DhcpV4FailoverDeleteRelationship

DhcpV4FailoverGetRelationship

DhcpV4FailoverSetRelationship