ClusterGroupSetControl 関数 (clusapi.h)
グループセットに影響を与える操作を開始します。
実行される操作は、dwControlCode パラメーターに渡されるコントロール コードによって異なります。
構文
DWORD ClusterGroupSetControl(
[in] HGROUPSET hGroupSet,
[in, optional] HNODE hHostNode,
[in] DWORD dwControlCode,
[in, optional] LPVOID lpInBuffer,
[in] DWORD cbInBufferSize,
[out, optional] LPVOID lpOutBuffer,
[in] DWORD cbOutBufferSize,
[out, optional] LPDWORD lpBytesReturned
);
パラメーター
[in] hGroupSet
影響を受けるグループセットへのハンドル。
[in, optional] hHostNode
NULL 以外の場合は、コントロール コードで表される操作を実行するノードを処理します。 NULL の場合、グループセットを所有するノードが操作を実行します。 hHostNode の指定は省略可能です。
[in] dwControlCode
実行する操作を指定する コレクション コントロール コード 。 コントロール コードに関連付けられている構文については、 を参照してください。
コード アーキテクチャ と次のトピックを制御します。
- CLUSCTL_GROUPSET_GET_COMMON_PROPERTIES
- CLUSCTL_GROUPSET_GET_GROUPS
- CLUSCTL_GROUPSET_GET_PROVIDER_GROUPS
- CLUSCTL_GROUPSET_GET_PROVIDER_COLLECTIONS
- CLUSCTL_GROUPSET_GET_RO_COMMON_PROPERTIES
- CLUSCTL_GROUPSET_SET_COMMON_PROPERTIES
- CLUSCTL_GROUP_GET_PROVIDER_GROUPS
- CLUSCTL_GROUP_GET_PROVIDER_COLLECTIONS
[in, optional] lpInBuffer
操作に必要な情報を含む入力バッファーへのポインター。情報が必要ない場合は NULL 。
[in] cbInBufferSize
入力バッファーの割り当てられたサイズ (バイト単位)。
[out, optional] lpOutBuffer
操作の結果として得られるデータを受け取る出力バッファーへのポインター。データが返されない場合は NULL 。
[in] cbOutBufferSize
出力バッファーの割り当てられたサイズ (バイト単位)。
[out, optional] lpBytesReturned
操作に起因するデータの実際のサイズ (バイト単位) を返します。 この情報が必要ない場合は、lpBytesReturned に NULL を渡します。
戻り値
関数は、次のいずれかの値を返します。
リターン コード | 説明 |
---|---|
|
操作に成功しました。 操作で出力バッファーが必要な場合、 lpBytesReturned (入力時に NULL でない場合) は、バッファーに返されるデータの実際のサイズを指します。 |
|
lpOutBuffer が指す出力バッファーが、操作の結果として得られるデータを保持するのに十分な大きさではなかった。 lpBytesReturned パラメーター (入力時に NULL でない場合) は、出力バッファーに必要なサイズを指します。 出力バッファーを必要とする操作のみが ERROR_MORE_DATAを返します。 lpOutBuffer パラメーターが NULL で、nOutBufferSize パラメーターが 0 の場合は、ERROR_MORE_DATAではなく、ERROR_SUCCESSが返される可能性があります。 |
操作が成功しなかった。 操作で出力バッファーが必要な場合、 lpBytesReturned (入力時に NULL でない場合) で指定された値は信頼できません。 |
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows Server 2016 |
対象プラットフォーム | Windows |
ヘッダー | clusapi.h |
Library | ClusAPI.lib |
[DLL] | ClusAPI.dll |