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

GetClusterNotify

関数
通知ポートから次のクラスター通知イベントを取得する。
DLLCLUSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD GetClusterNotify(
    HCHANGE hChange,
    UINT_PTR* lpdwNotifyKey,
    DWORD* lpdwFilterType,
    LPWSTR lpszName,
    DWORD* lpcchName,
    DWORD dwMilliseconds
);

パラメーター

名前方向説明
hChangeHCHANGEinCreateClusterNotifyPortで作成した通知ポートハンドル。
lpdwNotifyKeyUINT_PTR*out通知を発生させた登録に紐付くユーザー定義キーを受け取る出力。
lpdwFilterTypeDWORD*out発生したイベントの種別(CLUSTER_CHANGE_*)を受け取る出力。
lpszNameLPWSTRoutイベント対象オブジェクト名を受け取るバッファへのポインタ。
lpcchNameDWORD*inout入出力で名前バッファの容量と文字数を受け渡すポインタ。
dwMillisecondsDWORDin通知到着を待機する最大時間(ミリ秒)。INFINITEで無期限待機。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetClusterNotify(
    HCHANGE hChange,
    UINT_PTR* lpdwNotifyKey,
    DWORD* lpdwFilterType,
    LPWSTR lpszName,
    DWORD* lpcchName,
    DWORD dwMilliseconds
);
[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint GetClusterNotify(
    IntPtr hChange,   // HCHANGE
    out UIntPtr lpdwNotifyKey,   // UINT_PTR* out
    out uint lpdwFilterType,   // DWORD* out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszName,   // LPWSTR out
    ref uint lpcchName,   // DWORD* in/out
    uint dwMilliseconds   // DWORD
);
<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function GetClusterNotify(
    hChange As IntPtr,   ' HCHANGE
    <Out> ByRef lpdwNotifyKey As UIntPtr,   ' UINT_PTR* out
    <Out> ByRef lpdwFilterType As UInteger,   ' DWORD* out
    <MarshalAs(UnmanagedType.LPWStr)> lpszName As System.Text.StringBuilder,   ' LPWSTR out
    ByRef lpcchName As UInteger,   ' DWORD* in/out
    dwMilliseconds As UInteger   ' DWORD
) As UInteger
End Function
' hChange : HCHANGE
' lpdwNotifyKey : UINT_PTR* out
' lpdwFilterType : DWORD* out
' lpszName : LPWSTR out
' lpcchName : DWORD* in/out
' dwMilliseconds : DWORD
Declare PtrSafe Function GetClusterNotify Lib "clusapi" ( _
    ByVal hChange As LongPtr, _
    ByRef lpdwNotifyKey As LongPtr, _
    ByRef lpdwFilterType As Long, _
    ByVal lpszName As LongPtr, _
    ByRef lpcchName As Long, _
    ByVal dwMilliseconds As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetClusterNotify = ctypes.windll.clusapi.GetClusterNotify
GetClusterNotify.restype = wintypes.DWORD
GetClusterNotify.argtypes = [
    ctypes.c_ssize_t,  # hChange : HCHANGE
    ctypes.POINTER(ctypes.c_size_t),  # lpdwNotifyKey : UINT_PTR* out
    ctypes.POINTER(wintypes.DWORD),  # lpdwFilterType : DWORD* out
    wintypes.LPWSTR,  # lpszName : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpcchName : DWORD* in/out
    wintypes.DWORD,  # dwMilliseconds : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CLUSAPI.dll')
GetClusterNotify = Fiddle::Function.new(
  lib['GetClusterNotify'],
  [
    Fiddle::TYPE_INTPTR_T,  # hChange : HCHANGE
    Fiddle::TYPE_VOIDP,  # lpdwNotifyKey : UINT_PTR* out
    Fiddle::TYPE_VOIDP,  # lpdwFilterType : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpszName : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpcchName : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "clusapi")]
extern "system" {
    fn GetClusterNotify(
        hChange: isize,  // HCHANGE
        lpdwNotifyKey: *mut usize,  // UINT_PTR* out
        lpdwFilterType: *mut u32,  // DWORD* out
        lpszName: *mut u16,  // LPWSTR out
        lpcchName: *mut u32,  // DWORD* in/out
        dwMilliseconds: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint GetClusterNotify(IntPtr hChange, out UIntPtr lpdwNotifyKey, out uint lpdwFilterType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszName, ref uint lpcchName, uint dwMilliseconds);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_GetClusterNotify' -Namespace Win32 -PassThru
# $api::GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds)
#uselib "CLUSAPI.dll"
#func global GetClusterNotify "GetClusterNotify" sptr, sptr, sptr, sptr, sptr, sptr
; GetClusterNotify hChange, varptr(lpdwNotifyKey), varptr(lpdwFilterType), varptr(lpszName), varptr(lpcchName), dwMilliseconds   ; 戻り値は stat
; hChange : HCHANGE -> "sptr"
; lpdwNotifyKey : UINT_PTR* out -> "sptr"
; lpdwFilterType : DWORD* out -> "sptr"
; lpszName : LPWSTR out -> "sptr"
; lpcchName : DWORD* in/out -> "sptr"
; dwMilliseconds : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CLUSAPI.dll"
#cfunc global GetClusterNotify "GetClusterNotify" sptr, var, var, var, var, int
; res = GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds)
; hChange : HCHANGE -> "sptr"
; lpdwNotifyKey : UINT_PTR* out -> "var"
; lpdwFilterType : DWORD* out -> "var"
; lpszName : LPWSTR out -> "var"
; lpcchName : DWORD* in/out -> "var"
; dwMilliseconds : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetClusterNotify(HCHANGE hChange, UINT_PTR* lpdwNotifyKey, DWORD* lpdwFilterType, LPWSTR lpszName, DWORD* lpcchName, DWORD dwMilliseconds)
#uselib "CLUSAPI.dll"
#cfunc global GetClusterNotify "GetClusterNotify" intptr, var, var, var, var, int
; res = GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds)
; hChange : HCHANGE -> "intptr"
; lpdwNotifyKey : UINT_PTR* out -> "var"
; lpdwFilterType : DWORD* out -> "var"
; lpszName : LPWSTR out -> "var"
; lpcchName : DWORD* in/out -> "var"
; dwMilliseconds : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procGetClusterNotify = clusapi.NewProc("GetClusterNotify")
)

// hChange (HCHANGE), lpdwNotifyKey (UINT_PTR* out), lpdwFilterType (DWORD* out), lpszName (LPWSTR out), lpcchName (DWORD* in/out), dwMilliseconds (DWORD)
r1, _, err := procGetClusterNotify.Call(
	uintptr(hChange),
	uintptr(lpdwNotifyKey),
	uintptr(lpdwFilterType),
	uintptr(lpszName),
	uintptr(lpcchName),
	uintptr(dwMilliseconds),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetClusterNotify(
  hChange: NativeInt;   // HCHANGE
  lpdwNotifyKey: Pointer;   // UINT_PTR* out
  lpdwFilterType: Pointer;   // DWORD* out
  lpszName: PWideChar;   // LPWSTR out
  lpcchName: Pointer;   // DWORD* in/out
  dwMilliseconds: DWORD   // DWORD
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'GetClusterNotify';
result := DllCall("CLUSAPI\GetClusterNotify"
    , "Ptr", hChange   ; HCHANGE
    , "Ptr", lpdwNotifyKey   ; UINT_PTR* out
    , "Ptr", lpdwFilterType   ; DWORD* out
    , "Ptr", lpszName   ; LPWSTR out
    , "Ptr", lpcchName   ; DWORD* in/out
    , "UInt", dwMilliseconds   ; DWORD
    , "UInt")   ; return: DWORD
●GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds) = DLL("CLUSAPI.dll", "dword GetClusterNotify(int, void*, void*, char*, void*, dword)")
# 呼び出し: GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds)
# hChange : HCHANGE -> "int"
# lpdwNotifyKey : UINT_PTR* out -> "void*"
# lpdwFilterType : DWORD* out -> "void*"
# lpszName : LPWSTR out -> "char*"
# lpcchName : DWORD* in/out -> "void*"
# dwMilliseconds : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "clusapi" fn GetClusterNotify(
    hChange: isize, // HCHANGE
    lpdwNotifyKey: [*c]usize, // UINT_PTR* out
    lpdwFilterType: [*c]u32, // DWORD* out
    lpszName: [*c]u16, // LPWSTR out
    lpcchName: [*c]u32, // DWORD* in/out
    dwMilliseconds: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc GetClusterNotify(
    hChange: int,  # HCHANGE
    lpdwNotifyKey: ptr uint,  # UINT_PTR* out
    lpdwFilterType: ptr uint32,  # DWORD* out
    lpszName: ptr uint16,  # LPWSTR out
    lpcchName: ptr uint32,  # DWORD* in/out
    dwMilliseconds: uint32  # DWORD
): uint32 {.importc: "GetClusterNotify", stdcall, dynlib: "CLUSAPI.dll".}
pragma(lib, "clusapi");
extern(Windows)
uint GetClusterNotify(
    ptrdiff_t hChange,   // HCHANGE
    size_t* lpdwNotifyKey,   // UINT_PTR* out
    uint* lpdwFilterType,   // DWORD* out
    wchar* lpszName,   // LPWSTR out
    uint* lpcchName,   // DWORD* in/out
    uint dwMilliseconds   // DWORD
);
ccall((:GetClusterNotify, "CLUSAPI.dll"), stdcall, UInt32,
      (Int, Ptr{Csize_t}, Ptr{UInt32}, Ptr{UInt16}, Ptr{UInt32}, UInt32),
      hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds)
# hChange : HCHANGE -> Int
# lpdwNotifyKey : UINT_PTR* out -> Ptr{Csize_t}
# lpdwFilterType : DWORD* out -> Ptr{UInt32}
# lpszName : LPWSTR out -> Ptr{UInt16}
# lpcchName : DWORD* in/out -> Ptr{UInt32}
# dwMilliseconds : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetClusterNotify(
    intptr_t hChange,
    uintptr_t* lpdwNotifyKey,
    uint32_t* lpdwFilterType,
    uint16_t* lpszName,
    uint32_t* lpcchName,
    uint32_t dwMilliseconds);
]]
local clusapi = ffi.load("clusapi")
-- clusapi.GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds)
-- hChange : HCHANGE
-- lpdwNotifyKey : UINT_PTR* out
-- lpdwFilterType : DWORD* out
-- lpszName : LPWSTR out
-- lpcchName : DWORD* in/out
-- dwMilliseconds : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CLUSAPI.dll');
const GetClusterNotify = lib.func('__stdcall', 'GetClusterNotify', 'uint32_t', ['intptr_t', 'uintptr_t *', 'uint32_t *', 'uint16_t *', 'uint32_t *', 'uint32_t']);
// GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds)
// hChange : HCHANGE -> 'intptr_t'
// lpdwNotifyKey : UINT_PTR* out -> 'uintptr_t *'
// lpdwFilterType : DWORD* out -> 'uint32_t *'
// lpszName : LPWSTR out -> 'uint16_t *'
// lpcchName : DWORD* in/out -> 'uint32_t *'
// dwMilliseconds : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CLUSAPI.dll", {
  GetClusterNotify: { parameters: ["isize", "pointer", "pointer", "buffer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds)
// hChange : HCHANGE -> "isize"
// lpdwNotifyKey : UINT_PTR* out -> "pointer"
// lpdwFilterType : DWORD* out -> "pointer"
// lpszName : LPWSTR out -> "buffer"
// lpcchName : DWORD* in/out -> "pointer"
// dwMilliseconds : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetClusterNotify(
    intptr_t hChange,
    size_t* lpdwNotifyKey,
    uint32_t* lpdwFilterType,
    uint16_t* lpszName,
    uint32_t* lpcchName,
    uint32_t dwMilliseconds);
C, "CLUSAPI.dll");
// $ffi->GetClusterNotify(hChange, lpdwNotifyKey, lpdwFilterType, lpszName, lpcchName, dwMilliseconds);
// hChange : HCHANGE
// lpdwNotifyKey : UINT_PTR* out
// lpdwFilterType : DWORD* out
// lpszName : LPWSTR out
// lpcchName : DWORD* in/out
// dwMilliseconds : 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 GetClusterNotify(
        long hChange,   // HCHANGE
        LongByReference lpdwNotifyKey,   // UINT_PTR* out
        IntByReference lpdwFilterType,   // DWORD* out
        char[] lpszName,   // LPWSTR out
        IntByReference lpcchName,   // DWORD* in/out
        int dwMilliseconds   // DWORD
    );
}
@[Link("clusapi")]
lib LibCLUSAPI
  fun GetClusterNotify = GetClusterNotify(
    hChange : LibC::SSizeT,   # HCHANGE
    lpdwNotifyKey : LibC::SizeT*,   # UINT_PTR* out
    lpdwFilterType : UInt32*,   # DWORD* out
    lpszName : UInt16*,   # LPWSTR out
    lpcchName : UInt32*,   # DWORD* in/out
    dwMilliseconds : 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 GetClusterNotifyNative = Uint32 Function(IntPtr, Pointer<UintPtr>, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>, Uint32);
typedef GetClusterNotifyDart = int Function(int, Pointer<UintPtr>, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>, int);
final GetClusterNotify = DynamicLibrary.open('CLUSAPI.dll')
    .lookupFunction<GetClusterNotifyNative, GetClusterNotifyDart>('GetClusterNotify');
// hChange : HCHANGE -> IntPtr
// lpdwNotifyKey : UINT_PTR* out -> Pointer<UintPtr>
// lpdwFilterType : DWORD* out -> Pointer<Uint32>
// lpszName : LPWSTR out -> Pointer<Utf16>
// lpcchName : DWORD* in/out -> Pointer<Uint32>
// dwMilliseconds : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetClusterNotify(
  hChange: NativeInt;   // HCHANGE
  lpdwNotifyKey: Pointer;   // UINT_PTR* out
  lpdwFilterType: Pointer;   // DWORD* out
  lpszName: PWideChar;   // LPWSTR out
  lpcchName: Pointer;   // DWORD* in/out
  dwMilliseconds: DWORD   // DWORD
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'GetClusterNotify';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetClusterNotify"
  c_GetClusterNotify :: CIntPtr -> Ptr CUIntPtr -> Ptr Word32 -> CWString -> Ptr Word32 -> Word32 -> IO Word32
-- hChange : HCHANGE -> CIntPtr
-- lpdwNotifyKey : UINT_PTR* out -> Ptr CUIntPtr
-- lpdwFilterType : DWORD* out -> Ptr Word32
-- lpszName : LPWSTR out -> CWString
-- lpcchName : DWORD* in/out -> Ptr Word32
-- dwMilliseconds : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getclusternotify =
  foreign "GetClusterNotify"
    (intptr_t @-> (ptr size_t) @-> (ptr uint32_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> uint32_t @-> returning uint32_t)
(* hChange : HCHANGE -> intptr_t *)
(* lpdwNotifyKey : UINT_PTR* out -> (ptr size_t) *)
(* lpdwFilterType : DWORD* out -> (ptr uint32_t) *)
(* lpszName : LPWSTR out -> (ptr uint16_t) *)
(* lpcchName : DWORD* in/out -> (ptr uint32_t) *)
(* dwMilliseconds : 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 ("GetClusterNotify" get-cluster-notify :convention :stdcall) :uint32
  (h-change :int64)   ; HCHANGE
  (lpdw-notify-key :pointer)   ; UINT_PTR* out
  (lpdw-filter-type :pointer)   ; DWORD* out
  (lpsz-name :pointer)   ; LPWSTR out
  (lpcch-name :pointer)   ; DWORD* in/out
  (dw-milliseconds :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetClusterNotify = Win32::API::More->new('CLUSAPI',
    'DWORD GetClusterNotify(LPARAM hChange, LPVOID lpdwNotifyKey, LPVOID lpdwFilterType, LPWSTR lpszName, LPVOID lpcchName, DWORD dwMilliseconds)');
# my $ret = $GetClusterNotify->Call($hChange, $lpdwNotifyKey, $lpdwFilterType, $lpszName, $lpcchName, $dwMilliseconds);
# hChange : HCHANGE -> LPARAM
# lpdwNotifyKey : UINT_PTR* out -> LPVOID
# lpdwFilterType : DWORD* out -> LPVOID
# lpszName : LPWSTR out -> LPWSTR
# lpcchName : DWORD* in/out -> LPVOID
# dwMilliseconds : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。