OfflineClusterResourceEx
関数シグネチャ
// CLUSAPI.dll
#include <windows.h>
DWORD OfflineClusterResourceEx(
HRESOURCE hResource,
DWORD dwOfflineFlags,
BYTE* lpInBuffer, // optional
DWORD cbInBufferSize
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hResource | HRESOURCE | in | クラスターリソースへのハンドル。 |
| dwOfflineFlags | DWORD | in | オフラインポリシーに影響するフラグ。 このパラメーターには、次の値のうち 1 つ以上を設定できます。 CLUSAPI_RESOURCE_OFFLINE_IGNORE_RESOURCE_STATUS (0x00000001)リソースがロックされている場合、そのリソースの状態を無視します。 CLUSAPI_RESOURCE_OFFLINE_FORCE_WITH_TERMINATION (0x00000002)クリーンアップ処理の完了を待たずに、リソースを使用不可としてマークし、シャットダウンします。 CLUSAPI_RESOURCE_OFFLINE_REASON_NONE (0x00000000)フラグは指定されていません。 Windows Server 2012: この値は Windows Server 2012 R2 より前ではサポートされません。 CLUSAPI_RESOURCE_OFFLINE_REASON_UNKNOWN (0x00000001)理由は不明です。 Windows Server 2012: この値は Windows Server 2012 R2 より前ではサポートされません。 CLUSAPI_RESOURCE_OFFLINE_REASON_MOVING (0x00000002)リソースは別のノードへ移動中です。 Windows Server 2012: この値は Windows Server 2012 R2 より前ではサポートされません。 CLUSAPI_RESOURCE_OFFLINE_REASON_USER_REQUESTED (0x00000004)リソースをオフラインにするユーザー要求がありました。 Windows Server 2012: この値は Windows Server 2012 R2 より前ではサポートされません。 CLUSAPI_RESOURCE_OFFLINE_REASON_BEING_DELETED (0x00000008)リソースは削除中です。 Windows Server 2012: この値は Windows Server 2012 R2 より前ではサポートされません。 CLUSAPI_RESOURCE_OFFLINE_REASON_BEING_RESTARTED (0x00000010)リソースは再起動中です。 Windows Server 2012: この値は Windows Server 2012 R2 より前ではサポートされません。 CLUSAPI_RESOURCE_OFFLINE_REASON_PREEMPTED (0x00000020)リソースでプリエンプティブな障害が発生しました。 Windows Server 2012: この値は Windows Server 2012 R2 より前ではサポートされません。 CLUSAPI_RESOURCE_OFFLINE_REASON_SHUTTING_DOWN (0x00000040)リソースはシャットダウン中です。 Windows Server 2012: この値は Windows Server 2012 R2 より前ではサポートされません。 |
| lpInBuffer | BYTE* | inoptional | 特定のリソースを対象とした、オフライン操作の指示を格納します。lpInBuffer はプロパティリストとして書式設定されており、指示はプロパティ値に格納されます。リソース DLL はプロパティリストを検索して、オフライン操作でサポートするプロパティ名を探し、関連付けられたプロパティ値に含まれる指示を解釈します。なお、OfflineClusterResourceEx 操作でリソースがサポートするプロパティは、リソースに関連付けられたプライベートプロパティとは関係がありません。 |
| cbInBufferSize | DWORD | in | lpInBuffer のサイズ (バイト単位)。 |
戻り値の型: DWORD
公式ドキュメント
OfflineClusterResource メソッドを拡張します。
戻り値
OfflineClusterResourceEx は、オフラインコマンドが受け付けられて実行中である場合に ERROR_IO_PENDING を返します。オフラインコマンドが即座に拒否され、リソースの状態が変化しなかった場合、OfflineClusterResourceEx は 0 以外のエラーコードを返します。
解説(Remarks)
OfflineClusterResourceEx は、CLUSAPI_RESOURCE_OFFLINE_IGNORE_RESOURCE_LOCKED_STATUS フラグが設定されておらず、かつリソースが現在の状態で「ロックされている」ことを示している場合、エラー ERROR_CLUSTER_RESOURCE_LOCKED_STATUS で直ちに失敗します。
MoveClusterGroupEx と同様に、OfflineClusterResourceEx が ERROR_IO_PENDING を返した場合、クラスターサービスはリソースをオフライン状態にしようと試みます。
OfflineClusterResourceEx を使用するには、クラスターのセキュリティ記述子でクライアントに Full アクセスが許可されている必要があります。
例
#include "stdafx.h"
#include <windows.h>
#include <stdio.h>
#include <ClusAPI.h>
#define DemoResDllTypeName L"dummy"
#define DemoResourceName L"DemoResource"
BOOL WaitForResourceToGoOffline(__in HRESOURCE hResource)
{
for(;;)
{
CLUSTER_RESOURCE_STATE state = GetClusterResourceState( hResource, NULL, 0, NULL, 0 );
if( state == ClusterResourceOnline || state == ClusterResourceFailed)
{
return false;
}
else if ( state == ClusterResourceOffline )
{
return true;
}
Sleep(100);
}
}
int __cdecl main( void )
{
HCLUSTER hCluster= NULL;
HRESOURCE hResource = NULL;
DWORD error = 0;
hCluster = OpenCluster( NULL );
if ( hCluster == NULL )
{
error = GetLastError();
wprintf( L"Failed to open cluster: 0x%x\n", error );
goto Cleanup;
}
hResource = OpenClusterResource( hCluster, DemoResourceName );
if ( hResource == NULL )
{
error = GetLastError();
wprintf( L"Failed to open cluster resource " DemoResourceName L": 0x%x\n", error );
goto Cleanup;
}
// リソースをオフラインにする例
error = OfflineClusterResourceEx(hResource, CLUSAPI_RESOURCE_OFFLINE_IGNORE_RESOURCE_STATUS, NULL, 0);
if ( error == ERROR_IO_PENDING )
{
if (WaitForResourceToGoOffline(hResource))
{
error = ERROR_SUCCESS;
}
}
if ( error )
{
wprintf( L"Failed to offline the resource" DemoResourceName L": 0x%x\n", error );
goto Cleanup;
}
else
{
wprintf( L"Offlined the resource" DemoResourceName);
}
Cleanup:
if ( hResource != NULL )
{
CloseClusterResource( hResource );
hResource = NULL;
}
if ( hCluster != NULL )
{
CloseCluster( hCluster );
hCluster = NULL;
}
return (int)error;
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// CLUSAPI.dll
#include <windows.h>
DWORD OfflineClusterResourceEx(
HRESOURCE hResource,
DWORD dwOfflineFlags,
BYTE* lpInBuffer, // optional
DWORD cbInBufferSize
);[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint OfflineClusterResourceEx(
IntPtr hResource, // HRESOURCE
uint dwOfflineFlags, // DWORD
IntPtr lpInBuffer, // BYTE* optional
uint cbInBufferSize // DWORD
);<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function OfflineClusterResourceEx(
hResource As IntPtr, ' HRESOURCE
dwOfflineFlags As UInteger, ' DWORD
lpInBuffer As IntPtr, ' BYTE* optional
cbInBufferSize As UInteger ' DWORD
) As UInteger
End Function' hResource : HRESOURCE
' dwOfflineFlags : DWORD
' lpInBuffer : BYTE* optional
' cbInBufferSize : DWORD
Declare PtrSafe Function OfflineClusterResourceEx Lib "clusapi" ( _
ByVal hResource As LongPtr, _
ByVal dwOfflineFlags As Long, _
ByVal lpInBuffer As LongPtr, _
ByVal cbInBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
OfflineClusterResourceEx = ctypes.windll.clusapi.OfflineClusterResourceEx
OfflineClusterResourceEx.restype = wintypes.DWORD
OfflineClusterResourceEx.argtypes = [
ctypes.c_ssize_t, # hResource : HRESOURCE
wintypes.DWORD, # dwOfflineFlags : DWORD
ctypes.POINTER(ctypes.c_ubyte), # lpInBuffer : BYTE* optional
wintypes.DWORD, # cbInBufferSize : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('CLUSAPI.dll')
OfflineClusterResourceEx = Fiddle::Function.new(
lib['OfflineClusterResourceEx'],
[
Fiddle::TYPE_INTPTR_T, # hResource : HRESOURCE
-Fiddle::TYPE_INT, # dwOfflineFlags : DWORD
Fiddle::TYPE_VOIDP, # lpInBuffer : BYTE* optional
-Fiddle::TYPE_INT, # cbInBufferSize : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "clusapi")]
extern "system" {
fn OfflineClusterResourceEx(
hResource: isize, // HRESOURCE
dwOfflineFlags: u32, // DWORD
lpInBuffer: *mut u8, // BYTE* optional
cbInBufferSize: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint OfflineClusterResourceEx(IntPtr hResource, uint dwOfflineFlags, IntPtr lpInBuffer, uint cbInBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_OfflineClusterResourceEx' -Namespace Win32 -PassThru
# $api::OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize)#uselib "CLUSAPI.dll"
#func global OfflineClusterResourceEx "OfflineClusterResourceEx" sptr, sptr, sptr, sptr
; OfflineClusterResourceEx hResource, dwOfflineFlags, varptr(lpInBuffer), cbInBufferSize ; 戻り値は stat
; hResource : HRESOURCE -> "sptr"
; dwOfflineFlags : DWORD -> "sptr"
; lpInBuffer : BYTE* optional -> "sptr"
; cbInBufferSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "CLUSAPI.dll" #cfunc global OfflineClusterResourceEx "OfflineClusterResourceEx" sptr, int, var, int ; res = OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize) ; hResource : HRESOURCE -> "sptr" ; dwOfflineFlags : DWORD -> "int" ; lpInBuffer : BYTE* optional -> "var" ; cbInBufferSize : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CLUSAPI.dll" #cfunc global OfflineClusterResourceEx "OfflineClusterResourceEx" sptr, int, sptr, int ; res = OfflineClusterResourceEx(hResource, dwOfflineFlags, varptr(lpInBuffer), cbInBufferSize) ; hResource : HRESOURCE -> "sptr" ; dwOfflineFlags : DWORD -> "int" ; lpInBuffer : BYTE* optional -> "sptr" ; cbInBufferSize : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD OfflineClusterResourceEx(HRESOURCE hResource, DWORD dwOfflineFlags, BYTE* lpInBuffer, DWORD cbInBufferSize) #uselib "CLUSAPI.dll" #cfunc global OfflineClusterResourceEx "OfflineClusterResourceEx" intptr, int, var, int ; res = OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize) ; hResource : HRESOURCE -> "intptr" ; dwOfflineFlags : DWORD -> "int" ; lpInBuffer : BYTE* optional -> "var" ; cbInBufferSize : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD OfflineClusterResourceEx(HRESOURCE hResource, DWORD dwOfflineFlags, BYTE* lpInBuffer, DWORD cbInBufferSize) #uselib "CLUSAPI.dll" #cfunc global OfflineClusterResourceEx "OfflineClusterResourceEx" intptr, int, intptr, int ; res = OfflineClusterResourceEx(hResource, dwOfflineFlags, varptr(lpInBuffer), cbInBufferSize) ; hResource : HRESOURCE -> "intptr" ; dwOfflineFlags : DWORD -> "int" ; lpInBuffer : BYTE* optional -> "intptr" ; cbInBufferSize : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
procOfflineClusterResourceEx = clusapi.NewProc("OfflineClusterResourceEx")
)
// hResource (HRESOURCE), dwOfflineFlags (DWORD), lpInBuffer (BYTE* optional), cbInBufferSize (DWORD)
r1, _, err := procOfflineClusterResourceEx.Call(
uintptr(hResource),
uintptr(dwOfflineFlags),
uintptr(lpInBuffer),
uintptr(cbInBufferSize),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction OfflineClusterResourceEx(
hResource: NativeInt; // HRESOURCE
dwOfflineFlags: DWORD; // DWORD
lpInBuffer: Pointer; // BYTE* optional
cbInBufferSize: DWORD // DWORD
): DWORD; stdcall;
external 'CLUSAPI.dll' name 'OfflineClusterResourceEx';result := DllCall("CLUSAPI\OfflineClusterResourceEx"
, "Ptr", hResource ; HRESOURCE
, "UInt", dwOfflineFlags ; DWORD
, "Ptr", lpInBuffer ; BYTE* optional
, "UInt", cbInBufferSize ; DWORD
, "UInt") ; return: DWORD●OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize) = DLL("CLUSAPI.dll", "dword OfflineClusterResourceEx(int, dword, void*, dword)")
# 呼び出し: OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize)
# hResource : HRESOURCE -> "int"
# dwOfflineFlags : DWORD -> "dword"
# lpInBuffer : BYTE* optional -> "void*"
# cbInBufferSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "clusapi" fn OfflineClusterResourceEx(
hResource: isize, // HRESOURCE
dwOfflineFlags: u32, // DWORD
lpInBuffer: [*c]u8, // BYTE* optional
cbInBufferSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc OfflineClusterResourceEx(
hResource: int, # HRESOURCE
dwOfflineFlags: uint32, # DWORD
lpInBuffer: ptr uint8, # BYTE* optional
cbInBufferSize: uint32 # DWORD
): uint32 {.importc: "OfflineClusterResourceEx", stdcall, dynlib: "CLUSAPI.dll".}pragma(lib, "clusapi");
extern(Windows)
uint OfflineClusterResourceEx(
ptrdiff_t hResource, // HRESOURCE
uint dwOfflineFlags, // DWORD
ubyte* lpInBuffer, // BYTE* optional
uint cbInBufferSize // DWORD
);ccall((:OfflineClusterResourceEx, "CLUSAPI.dll"), stdcall, UInt32,
(Int, UInt32, Ptr{UInt8}, UInt32),
hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize)
# hResource : HRESOURCE -> Int
# dwOfflineFlags : DWORD -> UInt32
# lpInBuffer : BYTE* optional -> Ptr{UInt8}
# cbInBufferSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t OfflineClusterResourceEx(
intptr_t hResource,
uint32_t dwOfflineFlags,
uint8_t* lpInBuffer,
uint32_t cbInBufferSize);
]]
local clusapi = ffi.load("clusapi")
-- clusapi.OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize)
-- hResource : HRESOURCE
-- dwOfflineFlags : DWORD
-- lpInBuffer : BYTE* optional
-- cbInBufferSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('CLUSAPI.dll');
const OfflineClusterResourceEx = lib.func('__stdcall', 'OfflineClusterResourceEx', 'uint32_t', ['intptr_t', 'uint32_t', 'uint8_t *', 'uint32_t']);
// OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize)
// hResource : HRESOURCE -> 'intptr_t'
// dwOfflineFlags : DWORD -> 'uint32_t'
// lpInBuffer : BYTE* optional -> 'uint8_t *'
// cbInBufferSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("CLUSAPI.dll", {
OfflineClusterResourceEx: { parameters: ["isize", "u32", "pointer", "u32"], result: "u32" },
});
// lib.symbols.OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize)
// hResource : HRESOURCE -> "isize"
// dwOfflineFlags : DWORD -> "u32"
// lpInBuffer : BYTE* optional -> "pointer"
// cbInBufferSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t OfflineClusterResourceEx(
intptr_t hResource,
uint32_t dwOfflineFlags,
uint8_t* lpInBuffer,
uint32_t cbInBufferSize);
C, "CLUSAPI.dll");
// $ffi->OfflineClusterResourceEx(hResource, dwOfflineFlags, lpInBuffer, cbInBufferSize);
// hResource : HRESOURCE
// dwOfflineFlags : DWORD
// lpInBuffer : BYTE* optional
// cbInBufferSize : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Clusapi extends StdCallLibrary {
Clusapi INSTANCE = Native.load("clusapi", Clusapi.class);
int OfflineClusterResourceEx(
long hResource, // HRESOURCE
int dwOfflineFlags, // DWORD
byte[] lpInBuffer, // BYTE* optional
int cbInBufferSize // DWORD
);
}@[Link("clusapi")]
lib LibCLUSAPI
fun OfflineClusterResourceEx = OfflineClusterResourceEx(
hResource : LibC::SSizeT, # HRESOURCE
dwOfflineFlags : UInt32, # DWORD
lpInBuffer : UInt8*, # BYTE* optional
cbInBufferSize : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef OfflineClusterResourceExNative = Uint32 Function(IntPtr, Uint32, Pointer<Uint8>, Uint32);
typedef OfflineClusterResourceExDart = int Function(int, int, Pointer<Uint8>, int);
final OfflineClusterResourceEx = DynamicLibrary.open('CLUSAPI.dll')
.lookupFunction<OfflineClusterResourceExNative, OfflineClusterResourceExDart>('OfflineClusterResourceEx');
// hResource : HRESOURCE -> IntPtr
// dwOfflineFlags : DWORD -> Uint32
// lpInBuffer : BYTE* optional -> Pointer<Uint8>
// cbInBufferSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OfflineClusterResourceEx(
hResource: NativeInt; // HRESOURCE
dwOfflineFlags: DWORD; // DWORD
lpInBuffer: Pointer; // BYTE* optional
cbInBufferSize: DWORD // DWORD
): DWORD; stdcall;
external 'CLUSAPI.dll' name 'OfflineClusterResourceEx';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OfflineClusterResourceEx"
c_OfflineClusterResourceEx :: CIntPtr -> Word32 -> Ptr Word8 -> Word32 -> IO Word32
-- hResource : HRESOURCE -> CIntPtr
-- dwOfflineFlags : DWORD -> Word32
-- lpInBuffer : BYTE* optional -> Ptr Word8
-- cbInBufferSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let offlineclusterresourceex =
foreign "OfflineClusterResourceEx"
(intptr_t @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> returning uint32_t)
(* hResource : HRESOURCE -> intptr_t *)
(* dwOfflineFlags : DWORD -> uint32_t *)
(* lpInBuffer : BYTE* optional -> (ptr uint8_t) *)
(* cbInBufferSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library clusapi (t "CLUSAPI.dll"))
(cffi:use-foreign-library clusapi)
(cffi:defcfun ("OfflineClusterResourceEx" offline-cluster-resource-ex :convention :stdcall) :uint32
(h-resource :int64) ; HRESOURCE
(dw-offline-flags :uint32) ; DWORD
(lp-in-buffer :pointer) ; BYTE* optional
(cb-in-buffer-size :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OfflineClusterResourceEx = Win32::API::More->new('CLUSAPI',
'DWORD OfflineClusterResourceEx(LPARAM hResource, DWORD dwOfflineFlags, LPVOID lpInBuffer, DWORD cbInBufferSize)');
# my $ret = $OfflineClusterResourceEx->Call($hResource, $dwOfflineFlags, $lpInBuffer, $cbInBufferSize);
# hResource : HRESOURCE -> LPARAM
# dwOfflineFlags : DWORD -> DWORD
# lpInBuffer : BYTE* optional -> LPVOID
# cbInBufferSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f OfflineClusterResource — クラスターリソースをオフラインにする。
- f OfflineClusterResourceEx2 — 理由付きでクラスターリソースをオフラインにする。