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

OfflineClusterGroupEx2

関数
理由付きでクラスターグループをオフラインにする。
DLLCLUSAPI.dll呼出規約winapi

シグネチャ

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

DWORD OfflineClusterGroupEx2(
    HGROUP hGroup,
    DWORD dwOfflineFlags,
    BYTE* lpInBuffer,   // optional
    DWORD cbInBufferSize,
    LPCWSTR lpszReason   // optional
);

パラメーター

名前方向説明
hGroupHGROUPinオフラインにする対象クラスターグループのハンドル。
dwOfflineFlagsDWORDinオフライン動作を制御するフラグ。強制実行などを指定する。
lpInBufferBYTE*inoptionalリソース固有の入力データを格納したバッファ。不要時はNULL。
cbInBufferSizeDWORDinlpInBufferのバイト数。
lpszReasonLPCWSTRinoptional操作の理由を示すワイド文字列。監査ログ用で、NULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD OfflineClusterGroupEx2(
    HGROUP hGroup,
    DWORD dwOfflineFlags,
    BYTE* lpInBuffer,   // optional
    DWORD cbInBufferSize,
    LPCWSTR lpszReason   // optional
);
[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint OfflineClusterGroupEx2(
    IntPtr hGroup,   // HGROUP
    uint dwOfflineFlags,   // DWORD
    IntPtr lpInBuffer,   // BYTE* optional
    uint cbInBufferSize,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpszReason   // LPCWSTR optional
);
<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function OfflineClusterGroupEx2(
    hGroup As IntPtr,   ' HGROUP
    dwOfflineFlags As UInteger,   ' DWORD
    lpInBuffer As IntPtr,   ' BYTE* optional
    cbInBufferSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpszReason As String   ' LPCWSTR optional
) As UInteger
End Function
' hGroup : HGROUP
' dwOfflineFlags : DWORD
' lpInBuffer : BYTE* optional
' cbInBufferSize : DWORD
' lpszReason : LPCWSTR optional
Declare PtrSafe Function OfflineClusterGroupEx2 Lib "clusapi" ( _
    ByVal hGroup As LongPtr, _
    ByVal dwOfflineFlags As Long, _
    ByVal lpInBuffer As LongPtr, _
    ByVal cbInBufferSize As Long, _
    ByVal lpszReason As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OfflineClusterGroupEx2 = ctypes.windll.clusapi.OfflineClusterGroupEx2
OfflineClusterGroupEx2.restype = wintypes.DWORD
OfflineClusterGroupEx2.argtypes = [
    ctypes.c_ssize_t,  # hGroup : HGROUP
    wintypes.DWORD,  # dwOfflineFlags : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # lpInBuffer : BYTE* optional
    wintypes.DWORD,  # cbInBufferSize : DWORD
    wintypes.LPCWSTR,  # lpszReason : LPCWSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CLUSAPI.dll')
OfflineClusterGroupEx2 = Fiddle::Function.new(
  lib['OfflineClusterGroupEx2'],
  [
    Fiddle::TYPE_INTPTR_T,  # hGroup : HGROUP
    -Fiddle::TYPE_INT,  # dwOfflineFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpInBuffer : BYTE* optional
    -Fiddle::TYPE_INT,  # cbInBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpszReason : LPCWSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "clusapi")]
extern "system" {
    fn OfflineClusterGroupEx2(
        hGroup: isize,  // HGROUP
        dwOfflineFlags: u32,  // DWORD
        lpInBuffer: *mut u8,  // BYTE* optional
        cbInBufferSize: u32,  // DWORD
        lpszReason: *const u16  // LPCWSTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint OfflineClusterGroupEx2(IntPtr hGroup, uint dwOfflineFlags, IntPtr lpInBuffer, uint cbInBufferSize, [MarshalAs(UnmanagedType.LPWStr)] string lpszReason);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_OfflineClusterGroupEx2' -Namespace Win32 -PassThru
# $api::OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason)
#uselib "CLUSAPI.dll"
#func global OfflineClusterGroupEx2 "OfflineClusterGroupEx2" sptr, sptr, sptr, sptr, sptr
; OfflineClusterGroupEx2 hGroup, dwOfflineFlags, varptr(lpInBuffer), cbInBufferSize, lpszReason   ; 戻り値は stat
; hGroup : HGROUP -> "sptr"
; dwOfflineFlags : DWORD -> "sptr"
; lpInBuffer : BYTE* optional -> "sptr"
; cbInBufferSize : DWORD -> "sptr"
; lpszReason : LPCWSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CLUSAPI.dll"
#cfunc global OfflineClusterGroupEx2 "OfflineClusterGroupEx2" sptr, int, var, int, wstr
; res = OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason)
; hGroup : HGROUP -> "sptr"
; dwOfflineFlags : DWORD -> "int"
; lpInBuffer : BYTE* optional -> "var"
; cbInBufferSize : DWORD -> "int"
; lpszReason : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD OfflineClusterGroupEx2(HGROUP hGroup, DWORD dwOfflineFlags, BYTE* lpInBuffer, DWORD cbInBufferSize, LPCWSTR lpszReason)
#uselib "CLUSAPI.dll"
#cfunc global OfflineClusterGroupEx2 "OfflineClusterGroupEx2" intptr, int, var, int, wstr
; res = OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason)
; hGroup : HGROUP -> "intptr"
; dwOfflineFlags : DWORD -> "int"
; lpInBuffer : BYTE* optional -> "var"
; cbInBufferSize : DWORD -> "int"
; lpszReason : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procOfflineClusterGroupEx2 = clusapi.NewProc("OfflineClusterGroupEx2")
)

// hGroup (HGROUP), dwOfflineFlags (DWORD), lpInBuffer (BYTE* optional), cbInBufferSize (DWORD), lpszReason (LPCWSTR optional)
r1, _, err := procOfflineClusterGroupEx2.Call(
	uintptr(hGroup),
	uintptr(dwOfflineFlags),
	uintptr(lpInBuffer),
	uintptr(cbInBufferSize),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszReason))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function OfflineClusterGroupEx2(
  hGroup: NativeInt;   // HGROUP
  dwOfflineFlags: DWORD;   // DWORD
  lpInBuffer: Pointer;   // BYTE* optional
  cbInBufferSize: DWORD;   // DWORD
  lpszReason: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'OfflineClusterGroupEx2';
result := DllCall("CLUSAPI\OfflineClusterGroupEx2"
    , "Ptr", hGroup   ; HGROUP
    , "UInt", dwOfflineFlags   ; DWORD
    , "Ptr", lpInBuffer   ; BYTE* optional
    , "UInt", cbInBufferSize   ; DWORD
    , "WStr", lpszReason   ; LPCWSTR optional
    , "UInt")   ; return: DWORD
●OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason) = DLL("CLUSAPI.dll", "dword OfflineClusterGroupEx2(int, dword, void*, dword, char*)")
# 呼び出し: OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason)
# hGroup : HGROUP -> "int"
# dwOfflineFlags : DWORD -> "dword"
# lpInBuffer : BYTE* optional -> "void*"
# cbInBufferSize : DWORD -> "dword"
# lpszReason : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "clusapi" fn OfflineClusterGroupEx2(
    hGroup: isize, // HGROUP
    dwOfflineFlags: u32, // DWORD
    lpInBuffer: [*c]u8, // BYTE* optional
    cbInBufferSize: u32, // DWORD
    lpszReason: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u32;
proc OfflineClusterGroupEx2(
    hGroup: int,  # HGROUP
    dwOfflineFlags: uint32,  # DWORD
    lpInBuffer: ptr uint8,  # BYTE* optional
    cbInBufferSize: uint32,  # DWORD
    lpszReason: WideCString  # LPCWSTR optional
): uint32 {.importc: "OfflineClusterGroupEx2", stdcall, dynlib: "CLUSAPI.dll".}
pragma(lib, "clusapi");
extern(Windows)
uint OfflineClusterGroupEx2(
    ptrdiff_t hGroup,   // HGROUP
    uint dwOfflineFlags,   // DWORD
    ubyte* lpInBuffer,   // BYTE* optional
    uint cbInBufferSize,   // DWORD
    const(wchar)* lpszReason   // LPCWSTR optional
);
ccall((:OfflineClusterGroupEx2, "CLUSAPI.dll"), stdcall, UInt32,
      (Int, UInt32, Ptr{UInt8}, UInt32, Cwstring),
      hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason)
# hGroup : HGROUP -> Int
# dwOfflineFlags : DWORD -> UInt32
# lpInBuffer : BYTE* optional -> Ptr{UInt8}
# cbInBufferSize : DWORD -> UInt32
# lpszReason : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t OfflineClusterGroupEx2(
    intptr_t hGroup,
    uint32_t dwOfflineFlags,
    uint8_t* lpInBuffer,
    uint32_t cbInBufferSize,
    const uint16_t* lpszReason);
]]
local clusapi = ffi.load("clusapi")
-- clusapi.OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason)
-- hGroup : HGROUP
-- dwOfflineFlags : DWORD
-- lpInBuffer : BYTE* optional
-- cbInBufferSize : DWORD
-- lpszReason : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CLUSAPI.dll');
const OfflineClusterGroupEx2 = lib.func('__stdcall', 'OfflineClusterGroupEx2', 'uint32_t', ['intptr_t', 'uint32_t', 'uint8_t *', 'uint32_t', 'str16']);
// OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason)
// hGroup : HGROUP -> 'intptr_t'
// dwOfflineFlags : DWORD -> 'uint32_t'
// lpInBuffer : BYTE* optional -> 'uint8_t *'
// cbInBufferSize : DWORD -> 'uint32_t'
// lpszReason : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CLUSAPI.dll", {
  OfflineClusterGroupEx2: { parameters: ["isize", "u32", "pointer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason)
// hGroup : HGROUP -> "isize"
// dwOfflineFlags : DWORD -> "u32"
// lpInBuffer : BYTE* optional -> "pointer"
// cbInBufferSize : DWORD -> "u32"
// lpszReason : LPCWSTR optional -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t OfflineClusterGroupEx2(
    intptr_t hGroup,
    uint32_t dwOfflineFlags,
    uint8_t* lpInBuffer,
    uint32_t cbInBufferSize,
    const uint16_t* lpszReason);
C, "CLUSAPI.dll");
// $ffi->OfflineClusterGroupEx2(hGroup, dwOfflineFlags, lpInBuffer, cbInBufferSize, lpszReason);
// hGroup : HGROUP
// dwOfflineFlags : DWORD
// lpInBuffer : BYTE* optional
// cbInBufferSize : DWORD
// lpszReason : LPCWSTR optional
// 構造体/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 OfflineClusterGroupEx2(
        long hGroup,   // HGROUP
        int dwOfflineFlags,   // DWORD
        byte[] lpInBuffer,   // BYTE* optional
        int cbInBufferSize,   // DWORD
        WString lpszReason   // LPCWSTR optional
    );
}
@[Link("clusapi")]
lib LibCLUSAPI
  fun OfflineClusterGroupEx2 = OfflineClusterGroupEx2(
    hGroup : LibC::SSizeT,   # HGROUP
    dwOfflineFlags : UInt32,   # DWORD
    lpInBuffer : UInt8*,   # BYTE* optional
    cbInBufferSize : UInt32,   # DWORD
    lpszReason : UInt16*   # LPCWSTR optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OfflineClusterGroupEx2Native = Uint32 Function(IntPtr, Uint32, Pointer<Uint8>, Uint32, Pointer<Utf16>);
typedef OfflineClusterGroupEx2Dart = int Function(int, int, Pointer<Uint8>, int, Pointer<Utf16>);
final OfflineClusterGroupEx2 = DynamicLibrary.open('CLUSAPI.dll')
    .lookupFunction<OfflineClusterGroupEx2Native, OfflineClusterGroupEx2Dart>('OfflineClusterGroupEx2');
// hGroup : HGROUP -> IntPtr
// dwOfflineFlags : DWORD -> Uint32
// lpInBuffer : BYTE* optional -> Pointer<Uint8>
// cbInBufferSize : DWORD -> Uint32
// lpszReason : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OfflineClusterGroupEx2(
  hGroup: NativeInt;   // HGROUP
  dwOfflineFlags: DWORD;   // DWORD
  lpInBuffer: Pointer;   // BYTE* optional
  cbInBufferSize: DWORD;   // DWORD
  lpszReason: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'OfflineClusterGroupEx2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OfflineClusterGroupEx2"
  c_OfflineClusterGroupEx2 :: CIntPtr -> Word32 -> Ptr Word8 -> Word32 -> CWString -> IO Word32
-- hGroup : HGROUP -> CIntPtr
-- dwOfflineFlags : DWORD -> Word32
-- lpInBuffer : BYTE* optional -> Ptr Word8
-- cbInBufferSize : DWORD -> Word32
-- lpszReason : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let offlineclustergroupex2 =
  foreign "OfflineClusterGroupEx2"
    (intptr_t @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* hGroup : HGROUP -> intptr_t *)
(* dwOfflineFlags : DWORD -> uint32_t *)
(* lpInBuffer : BYTE* optional -> (ptr uint8_t) *)
(* cbInBufferSize : DWORD -> uint32_t *)
(* lpszReason : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clusapi (t "CLUSAPI.dll"))
(cffi:use-foreign-library clusapi)

(cffi:defcfun ("OfflineClusterGroupEx2" offline-cluster-group-ex2 :convention :stdcall) :uint32
  (h-group :int64)   ; HGROUP
  (dw-offline-flags :uint32)   ; DWORD
  (lp-in-buffer :pointer)   ; BYTE* optional
  (cb-in-buffer-size :uint32)   ; DWORD
  (lpsz-reason (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OfflineClusterGroupEx2 = Win32::API::More->new('CLUSAPI',
    'DWORD OfflineClusterGroupEx2(LPARAM hGroup, DWORD dwOfflineFlags, LPVOID lpInBuffer, DWORD cbInBufferSize, LPCWSTR lpszReason)');
# my $ret = $OfflineClusterGroupEx2->Call($hGroup, $dwOfflineFlags, $lpInBuffer, $cbInBufferSize, $lpszReason);
# hGroup : HGROUP -> LPARAM
# dwOfflineFlags : DWORD -> DWORD
# lpInBuffer : BYTE* optional -> LPVOID
# cbInBufferSize : DWORD -> DWORD
# lpszReason : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API