ホーム › Networking.Clustering › OnlineClusterGroup
OnlineClusterGroup
関数クラスターグループを指定ノード上でオンラインにする。
シグネチャ
// CLUSAPI.dll
#include <windows.h>
DWORD OnlineClusterGroup(
HGROUP hGroup,
HNODE hDestinationNode // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hGroup | HGROUP | in | オンラインにするグループのハンドル。 |
| hDestinationNode | HNODE | inoptional | hGroup で識別されるグループをオンラインにする ノード のハンドル、または NULL。 |
戻り値の型: DWORD
公式ドキュメント
グループをオンラインにします。(OnlineClusterGroup)
戻り値
操作が成功した場合、この関数は ERROR_SUCCESS を返します。
操作が失敗した場合、 この関数は システム エラー コード を返します。返される可能性があるエラー コードは次のとおりです。
| 戻り値 | 説明 |
|---|---|
| 適切なホスト ノードが利用できませんでした。 | |
| 操作が進行中です。 |
解説(Remarks)
hDestinationNode パラメーターで識別されるノードでグループをオンラインにできない場合、OnlineClusterGroup 関数は失敗します。
hDestinationNode パラメーターに NULL を指定した場合、OnlineClusterGroup は現在のノードでグループをオンラインにします。
リソース DLL から OnlineClusterGroup を呼び出さないでください。詳細については、Function Calls to Avoid in Resource DLLs を参照してください。
LPC ハンドルと RPC ハンドルを同一の関数呼び出しに渡さないでください。渡した場合、呼び出しは RPC 例外を発生させ、さらに破壊的な影響を及ぼす可能性があります。LPC ハンドルと RPC ハンドルの作成方法については、Using Object Handles および OpenCluster を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// CLUSAPI.dll
#include <windows.h>
DWORD OnlineClusterGroup(
HGROUP hGroup,
HNODE hDestinationNode // optional
);[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint OnlineClusterGroup(
IntPtr hGroup, // HGROUP
IntPtr hDestinationNode // HNODE optional
);<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function OnlineClusterGroup(
hGroup As IntPtr, ' HGROUP
hDestinationNode As IntPtr ' HNODE optional
) As UInteger
End Function' hGroup : HGROUP
' hDestinationNode : HNODE optional
Declare PtrSafe Function OnlineClusterGroup Lib "clusapi" ( _
ByVal hGroup As LongPtr, _
ByVal hDestinationNode As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
OnlineClusterGroup = ctypes.windll.clusapi.OnlineClusterGroup
OnlineClusterGroup.restype = wintypes.DWORD
OnlineClusterGroup.argtypes = [
ctypes.c_ssize_t, # hGroup : HGROUP
ctypes.c_ssize_t, # hDestinationNode : HNODE optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('CLUSAPI.dll')
OnlineClusterGroup = Fiddle::Function.new(
lib['OnlineClusterGroup'],
[
Fiddle::TYPE_INTPTR_T, # hGroup : HGROUP
Fiddle::TYPE_INTPTR_T, # hDestinationNode : HNODE optional
],
-Fiddle::TYPE_INT)#[link(name = "clusapi")]
extern "system" {
fn OnlineClusterGroup(
hGroup: isize, // HGROUP
hDestinationNode: isize // HNODE optional
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint OnlineClusterGroup(IntPtr hGroup, IntPtr hDestinationNode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_OnlineClusterGroup' -Namespace Win32 -PassThru
# $api::OnlineClusterGroup(hGroup, hDestinationNode)#uselib "CLUSAPI.dll"
#func global OnlineClusterGroup "OnlineClusterGroup" sptr, sptr
; OnlineClusterGroup hGroup, hDestinationNode ; 戻り値は stat
; hGroup : HGROUP -> "sptr"
; hDestinationNode : HNODE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "CLUSAPI.dll"
#cfunc global OnlineClusterGroup "OnlineClusterGroup" sptr, sptr
; res = OnlineClusterGroup(hGroup, hDestinationNode)
; hGroup : HGROUP -> "sptr"
; hDestinationNode : HNODE optional -> "sptr"; DWORD OnlineClusterGroup(HGROUP hGroup, HNODE hDestinationNode)
#uselib "CLUSAPI.dll"
#cfunc global OnlineClusterGroup "OnlineClusterGroup" intptr, intptr
; res = OnlineClusterGroup(hGroup, hDestinationNode)
; hGroup : HGROUP -> "intptr"
; hDestinationNode : HNODE optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
procOnlineClusterGroup = clusapi.NewProc("OnlineClusterGroup")
)
// hGroup (HGROUP), hDestinationNode (HNODE optional)
r1, _, err := procOnlineClusterGroup.Call(
uintptr(hGroup),
uintptr(hDestinationNode),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction OnlineClusterGroup(
hGroup: NativeInt; // HGROUP
hDestinationNode: NativeInt // HNODE optional
): DWORD; stdcall;
external 'CLUSAPI.dll' name 'OnlineClusterGroup';result := DllCall("CLUSAPI\OnlineClusterGroup"
, "Ptr", hGroup ; HGROUP
, "Ptr", hDestinationNode ; HNODE optional
, "UInt") ; return: DWORD●OnlineClusterGroup(hGroup, hDestinationNode) = DLL("CLUSAPI.dll", "dword OnlineClusterGroup(int, int)")
# 呼び出し: OnlineClusterGroup(hGroup, hDestinationNode)
# hGroup : HGROUP -> "int"
# hDestinationNode : HNODE optional -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "clusapi" fn OnlineClusterGroup(
hGroup: isize, // HGROUP
hDestinationNode: isize // HNODE optional
) callconv(std.os.windows.WINAPI) u32;proc OnlineClusterGroup(
hGroup: int, # HGROUP
hDestinationNode: int # HNODE optional
): uint32 {.importc: "OnlineClusterGroup", stdcall, dynlib: "CLUSAPI.dll".}pragma(lib, "clusapi");
extern(Windows)
uint OnlineClusterGroup(
ptrdiff_t hGroup, // HGROUP
ptrdiff_t hDestinationNode // HNODE optional
);ccall((:OnlineClusterGroup, "CLUSAPI.dll"), stdcall, UInt32,
(Int, Int),
hGroup, hDestinationNode)
# hGroup : HGROUP -> Int
# hDestinationNode : HNODE optional -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t OnlineClusterGroup(
intptr_t hGroup,
intptr_t hDestinationNode);
]]
local clusapi = ffi.load("clusapi")
-- clusapi.OnlineClusterGroup(hGroup, hDestinationNode)
-- hGroup : HGROUP
-- hDestinationNode : HNODE optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('CLUSAPI.dll');
const OnlineClusterGroup = lib.func('__stdcall', 'OnlineClusterGroup', 'uint32_t', ['intptr_t', 'intptr_t']);
// OnlineClusterGroup(hGroup, hDestinationNode)
// hGroup : HGROUP -> 'intptr_t'
// hDestinationNode : HNODE optional -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("CLUSAPI.dll", {
OnlineClusterGroup: { parameters: ["isize", "isize"], result: "u32" },
});
// lib.symbols.OnlineClusterGroup(hGroup, hDestinationNode)
// hGroup : HGROUP -> "isize"
// hDestinationNode : HNODE optional -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t OnlineClusterGroup(
intptr_t hGroup,
intptr_t hDestinationNode);
C, "CLUSAPI.dll");
// $ffi->OnlineClusterGroup(hGroup, hDestinationNode);
// hGroup : HGROUP
// hDestinationNode : HNODE 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 OnlineClusterGroup(
long hGroup, // HGROUP
long hDestinationNode // HNODE optional
);
}@[Link("clusapi")]
lib LibCLUSAPI
fun OnlineClusterGroup = OnlineClusterGroup(
hGroup : LibC::SSizeT, # HGROUP
hDestinationNode : LibC::SSizeT # HNODE optional
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef OnlineClusterGroupNative = Uint32 Function(IntPtr, IntPtr);
typedef OnlineClusterGroupDart = int Function(int, int);
final OnlineClusterGroup = DynamicLibrary.open('CLUSAPI.dll')
.lookupFunction<OnlineClusterGroupNative, OnlineClusterGroupDart>('OnlineClusterGroup');
// hGroup : HGROUP -> IntPtr
// hDestinationNode : HNODE optional -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OnlineClusterGroup(
hGroup: NativeInt; // HGROUP
hDestinationNode: NativeInt // HNODE optional
): DWORD; stdcall;
external 'CLUSAPI.dll' name 'OnlineClusterGroup';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OnlineClusterGroup"
c_OnlineClusterGroup :: CIntPtr -> CIntPtr -> IO Word32
-- hGroup : HGROUP -> CIntPtr
-- hDestinationNode : HNODE optional -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let onlineclustergroup =
foreign "OnlineClusterGroup"
(intptr_t @-> intptr_t @-> returning uint32_t)
(* hGroup : HGROUP -> intptr_t *)
(* hDestinationNode : HNODE optional -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library clusapi (t "CLUSAPI.dll"))
(cffi:use-foreign-library clusapi)
(cffi:defcfun ("OnlineClusterGroup" online-cluster-group :convention :stdcall) :uint32
(h-group :int64) ; HGROUP
(h-destination-node :int64)) ; HNODE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OnlineClusterGroup = Win32::API::More->new('CLUSAPI',
'DWORD OnlineClusterGroup(LPARAM hGroup, LPARAM hDestinationNode)');
# my $ret = $OnlineClusterGroup->Call($hGroup, $hDestinationNode);
# hGroup : HGROUP -> LPARAM
# hDestinationNode : HNODE optional -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
類似 API
- f OnlineClusterGroupEx — 入力バッファ指定でクラスターグループをオンラインにする。
- f OnlineClusterGroupEx2 — 理由付きでクラスターグループをオンラインにする。
公式の関連項目
- f OfflineClusterGroup — クラスターグループをオフラインにする。
- f OpenCluster — 指定名のクラスターを開きハンドルを返す。
- f OpenClusterGroup — 指定名のクラスターグループを開いてハンドルを取得する。