clusterControl 函式 (clusapi.h)

起始會影響 叢集的作業。 執行的作業取決於傳遞至dwControlCode參數的控制程式碼。

語法

DWORD ClusterControl(
  [in]            HCLUSTER hCluster,
  [in, optional]  HNODE    hHostNode,
  [in]            DWORD    dwControlCode,
  [in, optional]  LPVOID   lpInBuffer,
  [in]            DWORD    nInBufferSize,
  [out, optional] LPVOID   lpOutBuffer,
  [in]            DWORD    nOutBufferSize,
  [out, optional] LPDWORD  lpBytesReturned
);

參數

[in] hCluster

要受影響之叢集的控制碼。

[in, optional] hHostNode

如果為非Null，請處理節點，以執行控制項程式碼所代表的作業。 如果 為 Null，本機節點會執行作業。 指定 hHostNode 是選擇性的。

[in] dwControlCode

來自CLUSCTL_CLUSTER_CODES列舉的叢集控制程式代碼，指定要執行的作業。 如需與控制項程式碼相關聯的語法，請參閱 控制項程式碼架構 和下列主題：

• CLUSCTL_CLUSTER_CHECK_VOTER_DOWN
• CLUSCTL_CLUSTER_CHECK_VOTER_EVICT
• CLUSCTL_CLUSTER_CLEAR_NODE_CONNECTION_INFO
• CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES
• CLUSCTL_CLUSTER_ENUM_PRI加值稅E_PROPERTIES
• CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES
• CLUSCTL_CLUSTER_GET_FQDN
• CLUSCTL_CLUSTER_GET_COMMON_PROPERTY_FMTS
• CLUSCTL_CLUSTER_GET_PRI加值稅E_PROPERTIES
• CLUSCTL_CLUSTER_GET_PRI加值稅E_PROPERTY_FMTS
• CLUSCTL_CLUSTER_GET_RO_COMMON_PROPERTIES
• CLUSCTL_CLUSTER_GET_RO_PRI加值稅E_PROPERTIES
• CLUSCTL_CLUSTER_GET_SHARED_VOLUME_ID
• CLUSCTL_CLUSTER_SET_COMMON_PROPERTIES
• CLUSCTL_CLUSTER_SET_PRI加值稅E_PROPERTIES
• CLUSCTL_CLUSTER_SHUTDOWN
• CLUSCTL_CLUSTER_UNKNOWN
• CLUSCTL_CLUSTER_VALIDATE_COMMON_PROPERTIES
• CLUSCTL_CLUSTER_VALIDATE_PRI加值稅E_PROPERTIES

[in, optional] lpInBuffer

輸入緩衝區的指標，其中包含作業所需的資訊，如果不需要任何資訊，則為 Null 。

[in] nInBufferSize

輸入緩衝區) 的已配置大小 (以位元組為單位。

[out, optional] lpOutBuffer

輸出緩衝區的指標，以接收作業所產生的資料，如果未傳回任何資料，則為 Null 。

[in] nOutBufferSize

輸出緩衝區的已配置大小 (位元組) 。

[out, optional] lpBytesReturned

傳回實際大小 (，以位元組為單位，) 作業所產生的資料。 如果不需要這項資訊，請傳遞lHTTPBytesReturned的Null。

傳回值

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

傳回碼	Description
ERROR_SUCCESS	作業成功。 如果作業需要輸出緩衝區，如果輸入) 上不是Null，則 l (會指向緩衝區中傳回之資料的實際大小。
ERROR_MORE_DATA	lpOutBuffer指向的輸出緩衝區不夠大，無法保存作業所產生的資料。 如果輸入) 上不是Null，l (參數會指向輸出緩衝區所需的大小。 只有需要輸出緩衝區傳回 ERROR_MORE_DATA的作業。 如果 lpOutBuffer 參數為 Null ，且 nOutBufferSize 參數為零 ，則ERROR_SUCCESS 可能會傳回，而不是 ERROR_MORE_DATA。
系統錯誤碼	作業未成功。 如果作業需要輸出緩衝區，則如果輸入) 上不是Null，則 lHTTPBytesReturned所指定的值 (不可靠。

備註

如果 ClusterControl 傳 回 ERROR_MORE_DATA，請將 nOutBufferSize 設定為 lcsBytesReturned 所指向的位元組數目，然後再次呼叫函式。

請勿將 LPC 和 RPC 控制碼傳遞至相同的函式呼叫。 否則，呼叫將會引發 RPC 例外狀況，而且可能會有額外的破壞性影響。 如需如何建立 LPC 和 RPC 控制碼的資訊，請參閱 LPC 和 RPC 控制碼 和 OpenCluster。

ClusterControl 是其中一個 控制程式代碼函式。 如需控制程式代碼和控制程式代碼函式的詳細資訊，請參閱 使用控制項代碼。

規格需求

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

另請參閱

叢集控制程式代碼

OpenCluster