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

OpenClusterEx

関数
アクセス権を指定してクラスターを開きハンドルを返す。
DLLCLUSAPI.dll呼出規約winapiSetLastErrorあり対応OSwindowsserver2008

シグネチャ

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

HCLUSTER OpenClusterEx(
    LPCWSTR lpszClusterName,   // optional
    DWORD DesiredAccess,
    DWORD* GrantedAccess   // optional
);

パラメーター

名前方向説明
lpszClusterNameLPCWSTRinoptional接続するクラスタ名を指すワイド文字列。ローカルクラスタへ接続する場合はNULL可。
DesiredAccessDWORDin要求するアクセス権を示すマスク。GENERIC_READやGENERIC_ALL等を指定する。
GrantedAccessDWORD*outoptional実際に付与されたアクセス権を受け取る出力。

戻り値の型: HCLUSTER

各言語での呼び出し定義

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

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

OpenClusterEx = ctypes.windll.clusapi.OpenClusterEx
OpenClusterEx.restype = ctypes.c_ssize_t
OpenClusterEx.argtypes = [
    wintypes.LPCWSTR,  # lpszClusterName : LPCWSTR optional
    wintypes.DWORD,  # DesiredAccess : DWORD
    ctypes.POINTER(wintypes.DWORD),  # GrantedAccess : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procOpenClusterEx = clusapi.NewProc("OpenClusterEx")
)

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

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

typedef OpenClusterExNative = IntPtr Function(Pointer<Utf16>, Uint32, Pointer<Uint32>);
typedef OpenClusterExDart = int Function(Pointer<Utf16>, int, Pointer<Uint32>);
final OpenClusterEx = DynamicLibrary.open('CLUSAPI.dll')
    .lookupFunction<OpenClusterExNative, OpenClusterExDart>('OpenClusterEx');
// lpszClusterName : LPCWSTR optional -> Pointer<Utf16>
// DesiredAccess : DWORD -> Uint32
// GrantedAccess : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenClusterEx(
  lpszClusterName: PWideChar;   // LPCWSTR optional
  DesiredAccess: DWORD;   // DWORD
  GrantedAccess: Pointer   // DWORD* optional, out
): NativeInt; stdcall;
  external 'CLUSAPI.dll' name 'OpenClusterEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenClusterEx"
  c_OpenClusterEx :: CWString -> Word32 -> Ptr Word32 -> IO CIntPtr
-- lpszClusterName : LPCWSTR optional -> CWString
-- DesiredAccess : DWORD -> Word32
-- GrantedAccess : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openclusterex =
  foreign "OpenClusterEx"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> returning intptr_t)
(* lpszClusterName : LPCWSTR optional -> (ptr uint16_t) *)
(* DesiredAccess : DWORD -> uint32_t *)
(* GrantedAccess : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clusapi (t "CLUSAPI.dll"))
(cffi:use-foreign-library clusapi)

(cffi:defcfun ("OpenClusterEx" open-cluster-ex :convention :stdcall) :int64
  (lpsz-cluster-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (desired-access :uint32)   ; DWORD
  (granted-access :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenClusterEx = Win32::API::More->new('CLUSAPI',
    'LPARAM OpenClusterEx(LPCWSTR lpszClusterName, DWORD DesiredAccess, LPVOID GrantedAccess)');
# my $ret = $OpenClusterEx->Call($lpszClusterName, $DesiredAccess, $GrantedAccess);
# lpszClusterName : LPCWSTR optional -> LPCWSTR
# DesiredAccess : DWORD -> DWORD
# GrantedAccess : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API