ClusterResourceEnum 函式 (clusapi.h)

發行項
03/05/2024

列舉資源的相依資源、節點或兩者。它會在每個呼叫中傳回一個叢集物件的名稱。 PCLUSAPI_CLUSTER_RESOURCE_ENUM類型會定義此函式的指標。

語法

DWORD ClusterResourceEnum(
  [in]      HRESENUM hResEnum,
  [in]      DWORD    dwIndex,
  [out]     LPDWORD  lpdwType,
  [out]     LPWSTR   lpszName,
  [in, out] LPDWORD  lpcchName
);

參數

[in] hResEnum

從 ClusterResourceOpenEnum 函式傳回的資源列舉句柄。

[in] dwIndex

要傳回之資源或節點物件的索引。第一次呼叫 ClusterResourceEnum 函式時，此參數應該是零，然後針對後續呼叫遞增。

[out] lpdwType

ClusterResourceEnum 所傳回的物件類型。

可能的值為下列其中一個 CLUSTER_RESOURCE_ENUM 列舉值：

CLUSTER_RESOURCE_ENUM_DEPENDS (1)

對象是資源， 而 hResEnum 是相依於此對象的資源。

CLUSTER_RESOURCE_ENUM_PROVIDES (2)

對像是相依於 hResEnum 所識別之資源的資源。

CLUSTER_RESOURCE_ENUM_NODES (4)

對像是可裝載 hResEnum 所識別資源的節點。

[out] lpszName

以 Null 結尾的 Unicode 字串指標，其中包含傳回之物件的名稱。

[in, out] lpcchName

以字元計數表示 之 lpszName 緩衝區大小的指標。在輸入時，指定緩衝區可以保留的最大字元數，包括終止的 Null 字元。在輸出中，指定結果名稱中的字元數，不包括終止的 Null 字元。

傳回值

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

傳回碼/值	Description
ERROR_SUCCESS 0	作業成功完成，或 lpszName 參數為 NULL。
ERROR_MORE_DATA 234 (0xEA)	lpszName 參數指向的緩衝區不夠大，無法保存結果。 lpcchName 參數會傳回結果中的字元數，不包括終止的 Null 字元。
ERROR_NO_MORE_ITEMS 259 (0x103)	不會再傳回任何物件。
系統錯誤碼	任何其他傳回的錯誤碼都表示作業失敗。

備註

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

請勿從任何資源 DLL 進入點函式呼叫 ClusterResourceEnum 。您可以從背景工作線程安全地呼叫 ClusterResourceEnum。如需詳細資訊，請參閱在資源 DLL 中避免的函數調用。

範例

請參閱列舉物件。

規格需求

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

另請參閱

叢集資源管理功能

ClusterResourceCloseEnum

ClusterResourceOpenEnum

共用方式為