ClusterGroupEnum 函式 (clusapi.h)
列舉群組中的資源,或屬於群組慣用擁有者的節點,並傳回每個呼叫的資源或節點名稱。 PCLUSAPI_CLUSTER_GROUP_ENUM類型會定義此函式的指標。
語法
DWORD ClusterGroupEnum(
[in] HGROUPENUM hGroupEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszResourceName,
[in, out] LPDWORD lpcchName
);
參數
[in] hGroupEnum
ClusterGroupOpenEnum 函式所傳回的群組列舉句柄。
[in] dwIndex
要傳回之資源或節點的索引。 第一次呼叫 ClusterGroupEnum 時,此參數應該是零,然後針對後續呼叫遞增。
[out] lpdwType
ClusterGroupEnum 傳回之物件的型別指標。 以下是 CLUSTER_GROUP_ENUM 列舉的有效值。
CLUSTER_GROUP_ENUM_CONTAINS (1)
對像是群組中的其中一個資源。
CLUSTER_GROUP_ENUM_NODES (2)
對像是群組慣用擁有者清單中的其中一個節點。
[out] lpszResourceName
包含傳回之資源或節點名稱之 Null 終止 Unicode 字串的指標。
[in, out] lpcchName
lpszResourceName 緩衝區大小的指標,做為字元計數。 在輸入上,指定緩衝區可以保留的最大字元數,包括終止 的NULL。 在輸出上,指定結果名稱中的字元數,不包括終止 的NULL。
傳回值
函式可以傳回下列其中一個值。
傳回碼/值 | Description |
---|---|
|
作業已成功完成。 |
|
有更多可用的資料。 如果 lpszResourceName 所指向的緩衝區不足以保存結果,就會傳回此值。 lpcchName 參數會傳回結果中的字元數,不包括終止 NULL。 |
|
沒有其他可用的資料。 如果沒有更多要傳回的資源或節點,則會傳回此值。 |
如果作業因ERROR_NO_MORE_ITEMS或ERROR_MORE_DATA值所描述的問題而無法成功,ClusterGroupEnum 會傳回系統錯誤碼。
備註
請注意, lpcchName 是指字元計數,而不是位元組計數,而且傳回的大小不包含計數中的終止 NULL 。 如需調整緩衝區大小的詳細資訊,請參閱 數據大小慣例。
請勿從任何資源 DLL 進入點函式呼叫 ClusterGroupEnum 。 您可以從背景工作線程安全地呼叫 ClusterGroupEnum。 如需詳細資訊,請參閱 在資源 DLL 中避免的函式呼叫。
範例
請參閱 列舉物件。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 都不支援 |
最低支援的伺服器 | Windows Server 2008 Enterprise、Windows Server 2008 Datacenter |
目標平台 | Windows |
標頭 | clusapi.h |
程式庫 | ClusAPI.lib |
Dll | ClusAPI.dll |