GetClusterResourceState 函式 (clusapi.h)

發行項
08/22/2023

傳回資源的目前狀態。 PCLUSAPI_GET_CLUSTER_RESOURCE_STATE類型會定義此函式的指標。

語法

CLUSTER_RESOURCE_STATE GetClusterResourceState(
  [in]                HRESOURCE hResource,
  [out, optional]     LPWSTR    lpszNodeName,
  [in, out, optional] LPDWORD   lpcchNodeName,
  [out, optional]     LPWSTR    lpszGroupName,
  [in, out, optional] LPDWORD   lpcchGroupName
);

參數

[in] hResource

處理指定應該傳回狀態資訊的資源。

[out, optional] lpszNodeName

緩衝區的指標，接收指定資源目前擁有者節點的名稱做為 Null終止的 Unicode 字串。如果不需要節點名稱，則傳遞 Null 。

[in, out, optional] lpcchNodeName

lpszNodeName緩衝區大小做為字元計數的指標。除非lpszNodeName也是Null，否則此指標不可為Null。在輸入時，指定緩衝區可以保存的最大字元數，包括終止 的 Null。在輸出上，指定結果名稱中的字元數，不包括終止 的 Null。

[out, optional] lpszGroupName

緩衝區的指標，這個緩衝區會接收包含指定資源的群組名稱。此名稱會以 Null終止的 Unicode 字串傳回。如果不需要組名，請傳遞 Null 。

[in, out, optional] lpcchGroupName

lpszGroupName緩衝區大小做為字元計數的指標。除非lpszNodeName也是Null，否則此指標不可為Null。在輸入時，指定緩衝區可以保存的最大字元數，包括終止 的 Null。在輸出上，指定結果名稱中的字元數，不包括終止 的 Null。

傳回值

GetClusterResourceState 會傳回從 CLUSTER_RESOURCE_STATE 列舉列舉的資源目前狀態，可由下列其中一個值表示。

傳回碼/值	Description
ClusterResourceInitializing 1	資源正在執行初始化。
ClusterResourceOnline 2	資源正常運作。
ClusterResourceOffline 3	資源無法運作。如果資源回報 ClusterResourceOffline (3) 或 ClusterResourceCannotComeOnlineOnThisNode (127) 狀態，將會傳回此值。
ClusterResourceFailed 4	資源失敗。如果資源回報 ClusterResourceFailed (4) 或 ClusterResourceCannotComeOnlineOnAnyNode (126) 的狀態，將會傳回此值。
ClusterResourcePending 128	資源正在線上或離線。
ClusterResourceOnlinePending 129	資源即將上線。
ClusterResourceOfflinePending 130	資源正在離線。
ClusterResourceStateUnknown -1	作業未成功。如需錯誤的詳細資訊，請呼叫函式 GetLastError。

備註

請勿從任何資源 DLL 進入點函式呼叫 GetClusterResourceState 。可以從背景工作執行緒安全地呼叫GetClusterResourceState。如需詳細資訊，請參閱在資源 DLL 中避免的函式呼叫。

範例

如需範例，請參閱取得物件狀態。

規格需求


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