ClusterEnum 函式 (clusapi.h)

發行項
08/22/2023

列舉叢集中的叢集物件，並傳回每個呼叫的一個物件名稱。 PCLUSAPI_CLUSTER_ENUM類型會定義此函式的指標。

語法

DWORD ClusterEnum(
  [in]      HCLUSENUM hEnum,
  [in]      DWORD     dwIndex,
  [out]     LPDWORD   lpdwType,
  [out]     LPWSTR    lpszName,
  [in, out] LPDWORD   lpcchName
);

參數

[in] hEnum

ClusterOpenEnum函式所傳回的叢集列舉控制碼。

[in] dwIndex

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

[out] lpdwType

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

CLUSTER_ENUM_NODE (1 (0x1) )

列舉叢集中的節點。

CLUSTER_ENUM_RESTYPE (2 (0x2) )

列舉叢集中的資源類型。

CLUSTER_ENUM_RESOURCE (4 (0x4) )

列舉叢集中的資源。

CLUSTER_ENUM_GROUP (8 (0x8) )

列舉叢集中的群組。

CLUSTER_ENUM_NETWORK (16 (0x10) )

列舉叢集中的網路。

CLUSTER_ENUM_NETINTERFACE (32 (0x20) )

列舉叢集中的網路介面。

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000) )

列舉叢集所使用的叢集共用磁片區。

注意不同于大部分其他列舉位元遮罩，此值必須單獨使用。請勿使用 OR 運算子與其他位元遮罩結合。

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

CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000) )

列舉叢集用於內部通訊的網路。網路會依照 SetClusterNetworkPriorityOrder 函式所建立的最高優先順序順序列舉。

注意不同于大部分其他列舉位元遮罩，此值必須單獨使用。請勿使用 OR 運算子與其他位元遮罩結合。

CLUSTER_ENUM_ALL ( (CLUSTER_ENUM_NODE |CLUSTER_ENUM_RESTYPE |CLUSTER_ENUM_RESOURCE |CLUSTER_ENUM_GROUP |CLUSTER_ENUM_NETWORK |CLUSTER_ENUM_NETINTERFACE) )

列舉所有叢集物件。

[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。

備註

ClusterEnum函式通常用於逐一查看一或多個類型的叢集物件集合。例如，如果應用程式想要列舉叢集中的所有節點，它會呼叫 ClusterOpenEnum 來開啟可處理節點的叢集列舉值。 dwType參數會設定為CLUSTER_ENUM_NODE，以指定要列舉的物件類型來指定節點。如果應用程式除了節點之外列舉群組， dwType 參數會設定為 CLUSTER_ENUM_NODE | CLUSTER_ENUM_GROUP 。當 ClusterOpenEnum 傳回的控制碼時，應用程式會重複呼叫 ClusterEnum 來擷取每個物件。 lpdwType參數會指向所擷取的物件類型。

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

範例

請參閱列舉物件。

規格需求


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

另請參閱

ClusterCloseEnum

ClusterOpenEnum

SetClusterNetworkPriorityOrder

共用方式為