ホーム › Networking.Clustering › ClusterResourceControlAsUser

ClusterResourceControlAsUser

関数

呼び出しユーザー権限でリソース制御コードを実行する。

DLLCLUSAPI.dll呼出規約winapi対応OSwindowsserver2016

シグネチャ

// CLUSAPI.dll
#include <windows.h>

DWORD ClusterResourceControlAsUser(
    HRESOURCE hResource,
    HNODE hHostNode,   // optional
    DWORD dwControlCode,
    void* lpInBuffer,   // optional
    DWORD cbInBufferSize,
    void* lpOutBuffer,   // optional
    DWORD cbOutBufferSize,
    DWORD* lpBytesReturned   // optional
);

パラメーター

名前	型	方向	説明
hResource	HRESOURCE	in	対象となるリソースのハンドル。
hHostNode	HNODE	inoptional	操作を実行するノードのハンドル (省略可能)。NULL の場合は、 hResource で識別されるリソースを所有するノードが操作を実行します。
dwControlCode	DWORD	in	実行する操作を指定するリソース制御コードです。 CLUSCTL_RESOURCE_CODES 列挙型で列挙されています。制御コードに関連する構文については、CLUSCTL_RESOURCE_CODES のトピックにあるリンクを参照してください。
lpInBuffer	void*	inoptional	操作に必要な情報を格納した入力バッファーへのポインター。情報が不要な場合は NULL を指定します。
cbInBufferSize	DWORD	in	入力バッファーに割り当てられているサイズ (バイト単位)。
lpOutBuffer	void*	outoptional	操作の結果として得られるデータを受け取る出力バッファーへのポインター。データが返されない場合は NULL を指定します。
cbOutBufferSize	DWORD	in	出力バッファーに割り当てられているサイズ (バイト単位)。
lpBytesReturned	DWORD*	outoptional	操作の結果として得られたデータの実際のサイズ (バイト単位) が返されます。この情報が不要な場合は、 lpBytesReturned に NULL を渡します。

戻り値の型: DWORD

公式ドキュメント

リソースに影響を与える操作を開始します。

戻り値

この関数は次のいずれかの値を返します。

戻り値/値	説明
ERROR_SUCCESS 0	操作は成功しました。操作で出力バッファーが必要な場合、 lpBytesReturned (入力時に NULL でない場合) はバッファーに返されたデータの実際のサイズを指します。
ERROR_MORE_DATA 234 (0xEA)	lpOutBuffer が指す出力バッファーが、操作の結果として得られたデータを保持するのに十分な大きさではありませんでした。lpBytesReturned パラメーター (入力時に NULL でない場合) は、出力バッファーに必要なサイズを指します。ERROR_MORE_DATA を返すのは、出力バッファーを必要とする操作のみです。lpOutBuffer パラメーターが NULL で、 cbOutBufferSize パラメーターが 0 の場合は、ERROR_MORE_DATA ではなく ERROR_SUCCESS が返されることがあります。
ERROR_RESOURCE_PROPERTIES_STORED 5024 (0x13A0)	CLUSCTL_RESOURCE_SET_COMMON_PROPERTIES および CLUSCTL_RESOURCE_SET_PRIVATE_PROPERTIES にのみ適用されます。プロパティは正常に保存されましたが、まだリソースには適用されていないことを示します。新しいプロパティは、リソースをオフラインにしてから再度オンラインにした後に有効になります。
ERROR_HOST_NODE_NOT_RESOURCE_OWNER 5015 (0x1397)	hNode パラメーターで指定されたノードは、hResource で指定されたリソースを所有するノードではありません。
システムエラーコード	操作は失敗しました。操作で出力バッファーが必要な場合、lpBytesReturned で指定された値 (入力時に NULL でない場合) は信頼できません。

解説(Remarks)

ClusterResourceControl が ERROR_MORE_DATA を返した場合は、cbOutBufferSize に lpBytesReturned が指すバイト数を設定して、関数を再度呼び出してください。

同じ関数呼び出しに LPC ハンドルと RPC ハンドルを渡さないでください。渡した場合、呼び出しは RPC 例外を発生させ、さらに破壊的な影響を及ぼす可能性があります。LPC ハンドルと RPC ハンドルの作成方法については、 LPC and RPC Handles および OpenCluster を参照してください。

ClusterResourceControl 関数は、制御コード関数の 1 つです。制御コードおよび制御コード関数の詳細については、Using Control Codes を参照してください。

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

各言語での呼び出し定義

// CLUSAPI.dll
#include <windows.h>

DWORD ClusterResourceControlAsUser(
    HRESOURCE hResource,
    HNODE hHostNode,   // optional
    DWORD dwControlCode,
    void* lpInBuffer,   // optional
    DWORD cbInBufferSize,
    void* lpOutBuffer,   // optional
    DWORD cbOutBufferSize,
    DWORD* lpBytesReturned   // optional
);

[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint ClusterResourceControlAsUser(
    IntPtr hResource,   // HRESOURCE
    IntPtr hHostNode,   // HNODE optional
    uint dwControlCode,   // DWORD
    IntPtr lpInBuffer,   // void* optional
    uint cbInBufferSize,   // DWORD
    IntPtr lpOutBuffer,   // void* optional, out
    uint cbOutBufferSize,   // DWORD
    IntPtr lpBytesReturned   // DWORD* optional, out
);

<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function ClusterResourceControlAsUser(
    hResource As IntPtr,   ' HRESOURCE
    hHostNode As IntPtr,   ' HNODE optional
    dwControlCode As UInteger,   ' DWORD
    lpInBuffer As IntPtr,   ' void* optional
    cbInBufferSize As UInteger,   ' DWORD
    lpOutBuffer As IntPtr,   ' void* optional, out
    cbOutBufferSize As UInteger,   ' DWORD
    lpBytesReturned As IntPtr   ' DWORD* optional, out
) As UInteger
End Function

' hResource : HRESOURCE
' hHostNode : HNODE optional
' dwControlCode : DWORD
' lpInBuffer : void* optional
' cbInBufferSize : DWORD
' lpOutBuffer : void* optional, out
' cbOutBufferSize : DWORD
' lpBytesReturned : DWORD* optional, out
Declare PtrSafe Function ClusterResourceControlAsUser Lib "clusapi" ( _
    ByVal hResource As LongPtr, _
    ByVal hHostNode As LongPtr, _
    ByVal dwControlCode As Long, _
    ByVal lpInBuffer As LongPtr, _
    ByVal cbInBufferSize As Long, _
    ByVal lpOutBuffer As LongPtr, _
    ByVal cbOutBufferSize As Long, _
    ByVal lpBytesReturned As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ClusterResourceControlAsUser = ctypes.windll.clusapi.ClusterResourceControlAsUser
ClusterResourceControlAsUser.restype = wintypes.DWORD
ClusterResourceControlAsUser.argtypes = [
    ctypes.c_ssize_t,  # hResource : HRESOURCE
    ctypes.c_ssize_t,  # hHostNode : HNODE optional
    wintypes.DWORD,  # dwControlCode : DWORD
    ctypes.POINTER(None),  # lpInBuffer : void* optional
    wintypes.DWORD,  # cbInBufferSize : DWORD
    ctypes.POINTER(None),  # lpOutBuffer : void* optional, out
    wintypes.DWORD,  # cbOutBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpBytesReturned : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CLUSAPI.dll')
ClusterResourceControlAsUser = Fiddle::Function.new(
  lib['ClusterResourceControlAsUser'],
  [
    Fiddle::TYPE_INTPTR_T,  # hResource : HRESOURCE
    Fiddle::TYPE_INTPTR_T,  # hHostNode : HNODE optional
    -Fiddle::TYPE_INT,  # dwControlCode : DWORD
    Fiddle::TYPE_VOIDP,  # lpInBuffer : void* optional
    -Fiddle::TYPE_INT,  # cbInBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpOutBuffer : void* optional, out
    -Fiddle::TYPE_INT,  # cbOutBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpBytesReturned : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "clusapi")]
extern "system" {
    fn ClusterResourceControlAsUser(
        hResource: isize,  // HRESOURCE
        hHostNode: isize,  // HNODE optional
        dwControlCode: u32,  // DWORD
        lpInBuffer: *mut (),  // void* optional
        cbInBufferSize: u32,  // DWORD
        lpOutBuffer: *mut (),  // void* optional, out
        cbOutBufferSize: u32,  // DWORD
        lpBytesReturned: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint ClusterResourceControlAsUser(IntPtr hResource, IntPtr hHostNode, uint dwControlCode, IntPtr lpInBuffer, uint cbInBufferSize, IntPtr lpOutBuffer, uint cbOutBufferSize, IntPtr lpBytesReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_ClusterResourceControlAsUser' -Namespace Win32 -PassThru
# $api::ClusterResourceControlAsUser(hResource, hHostNode, dwControlCode, lpInBuffer, cbInBufferSize, lpOutBuffer, cbOutBufferSize, lpBytesReturned)

#uselib "CLUSAPI.dll"
#func global ClusterResourceControlAsUser "ClusterResourceControlAsUser" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ClusterResourceControlAsUser hResource, hHostNode, dwControlCode, lpInBuffer, cbInBufferSize, lpOutBuffer, cbOutBufferSize, varptr(lpBytesReturned)   ; 戻り値は stat
; hResource : HRESOURCE -> "sptr"
; hHostNode : HNODE optional -> "sptr"
; dwControlCode : DWORD -> "sptr"
; lpInBuffer : void* optional -> "sptr"
; cbInBufferSize : DWORD -> "sptr"
; lpOutBuffer : void* optional, out -> "sptr"
; cbOutBufferSize : DWORD -> "sptr"
; lpBytesReturned : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CLUSAPI.dll"
#cfunc global ClusterResourceControlAsUser "ClusterResourceControlAsUser" sptr, sptr, int, sptr, int, sptr, int, var
; res = ClusterResourceControlAsUser(hResource, hHostNode, dwControlCode, lpInBuffer, cbInBufferSize, lpOutBuffer, cbOutBufferSize, lpBytesReturned)
; hResource : HRESOURCE -> "sptr"
; hHostNode : HNODE optional -> "sptr"
; dwControlCode : DWORD -> "int"
; lpInBuffer : void* optional -> "sptr"
; cbInBufferSize : DWORD -> "int"
; lpOutBuffer : void* optional, out -> "sptr"
; cbOutBufferSize : DWORD -> "int"
; lpBytesReturned : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CLUSAPI.dll"
#cfunc global ClusterResourceControlAsUser "ClusterResourceControlAsUser" sptr, sptr, int, sptr, int, sptr, int, sptr
; res = ClusterResourceControlAsUser(hResource, hHostNode, dwControlCode, lpInBuffer, cbInBufferSize, lpOutBuffer, cbOutBufferSize, varptr(lpBytesReturned))
; hResource : HRESOURCE -> "sptr"
; hHostNode : HNODE optional -> "sptr"
; dwControlCode : DWORD -> "int"
; lpInBuffer : void* optional -> "sptr"
; cbInBufferSize : DWORD -> "int"
; lpOutBuffer : void* optional, out -> "sptr"
; cbOutBufferSize : DWORD -> "int"
; lpBytesReturned : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。