ClusterNodeEnum 函式 (clusapi.h)

發行項
02/23/2024

列舉節點上安裝的網路介面或群組，並傳回每個呼叫的名稱。 PCLUSAPI_CLUSTER_NODE_ENUM類型會定義此函式的指標。

語法

DWORD ClusterNodeEnum(
  [in]      HNODEENUM hNodeEnum,
  [in]      DWORD     dwIndex,
  [out]     LPDWORD   lpdwType,
  [out]     LPWSTR    lpszName,
  [in, out] LPDWORD   lpcchName
);

參數

[in] hNodeEnum

由 ClusterNodeOpenEnum 函式最初傳回的現有列舉物件句柄。

[in] dwIndex

用來識別要列舉之下一個專案的索引。第一次呼叫 ClusterNodeEnum 時，此參數應該是零，然後針對後續呼叫遞增。

[out] lpdwType

傳回之物件的型別指標。每個呼叫都會傳回下列CLUSTER_NODE_ENUM 列舉值。

CLUSTER_NODE_ENUM_NETINTERFACES (1)

對像是網路介面。

CLUSTER_NODE_ENUM_GROUPS (0x00000002)

對像是叢集群組。

Windows Server 2008： Windows Server 2008 R2 之前不支援 CLUSTER_NODE_ENUM_GROUPS 值。

[out] lpszName

Null 終止的 Unicode 字串指標，其中包含傳回對象的名稱。

[in, out] lpcchName

lpszName 緩衝區大小做為字元計數的指標。在輸入上，指定緩衝區可以保留的最大字元數，包括終止 的NULL。在輸出上，指定結果名稱中的字元數，不包括終止 的NULL。

傳回值

函式會傳回下列其中一個值。

傳回碼/值	Description
ERROR_SUCCESS 0	作業已成功完成。
ERROR_NO_MORE_ITEMS 259 (0x103)	沒有其他可用的資料。如果沒有更多要傳回的要求型別物件，就會傳回這個值。
ERROR_MORE_DATA 234 (0xEA)	有更多可用的資料。如果 lpszName 所指向的緩衝區不足以保存結果，就會傳回此值。 lpcchName 參數會傳回結果中的字元數，不包括終止 NULL。

備註

若要使用 ClusterNodeEnum，應用程式會先呼叫 ClusterNodeOpenEnum ，並將 dwType 參數設定為 CLUSTER_NODE_ENUM_NETINTERFACES，以開啟節點列舉句柄。如需詳細資訊，請參閱列舉物件。

請注意， lpcchName 參數是指字元計數，而不是位元組計數，而且傳回的大小不包含計數中的終止 NULL 。如需調整緩衝區大小的詳細資訊，請參閱數據大小慣例。

範例

請參閱列舉物件。

規格需求

需求	值
最低支援的用戶端	都不支援
最低支援的伺服器	Windows Server 2008 Enterprise、Windows Server 2008 Datacenter
目標平台	Windows
標頭	clusapi.h
程式庫	ClusAPI.lib
Dll	ClusAPI.dll