Win32 API 日本語リファレンス
ホーム › Networking.Clustering › PCLUSAPI_GET_CLUSTER_RESOURCE_STATE

PCLUSAPI_GET_CLUSTER_RESOURCE_STATE

コールバック

シグネチャ

CLUSTER_RESOURCE_STATE PCLUSAPI_GET_CLUSTER_RESOURCE_STATE(
    HRESOURCE hResource,
    LPWSTR lpszNodeName,
    DWORD* lpcchNodeName,
    LPWSTR lpszGroupName,
    DWORD* lpcchGroupName
);

パラメーター

フィールド型説明
hResourceHRESOURCE状態情報を取得する対象のリソースを指定するハンドルです。
lpszNodeNameLPWSTR指定したリソースの現在の所有者ノードの名前を、NULL 終端の Unicode 文字列として受け取るバッファーへのポインターです。ノード名が不要な場合は NULL を渡します。
lpcchNodeNameDWORD*lpszNodeName バッファーのサイズを文字数で示す値へのポインターです。lpszNodeName も NULL である場合を除き、このポインターを NULL にすることはできません。入力時は、終端の NULL を含めてバッファーが保持できる最大文字数を指定します。出力時は、終端の NULL を除いた、取得された名前の文字数が格納されます。
lpszGroupNameLPWSTR指定したリソースを含むグループの名前を受け取るバッファーへのポインターです。名前は NULL 終端の Unicode 文字列として返されます。グループ名が不要な場合は NULL を渡します。
lpcchGroupNameDWORD*lpszGroupName バッファーのサイズを文字数で示す値へのポインターです。lpszNodeName も NULL である場合を除き、このポインターを NULL にすることはできません。入力時は、終端の NULL を含めてバッファーが保持できる最大文字数を指定します。出力時は、終端の NULL を除いた、取得された名前の文字数が格納されます。

公式ドキュメント

リソースの現在の状態を返します。PCLUSAPI_GET_CLUSTER_RESOURCE_STATE 型は、この関数へのポインターを定義します。

戻り値

GetClusterResourceState は、CLUSTER_RESOURCE_STATE 列挙型から取得されたリソースの現在の状態を返します。状態は次のいずれかの値で表されます。

リターン コード/値 説明
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 関数を呼び出してください。

解説(Remarks)

リソース DLL のエントリ ポイント関数から GetClusterResourceState を呼び出さないでください。GetClusterResourceState は、ワーカー スレッドからであれば安全に呼び出せます。詳細については、Function Calls to Avoid in Resource DLLs を参照してください。

例

例については、Getting Object States を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)