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

SetClusterGroupNameEx

関数
理由付きでクラスターグループの名前を設定する。
DLLCLUSAPI.dll呼出規約winapi

シグネチャ

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

DWORD SetClusterGroupNameEx(
    HGROUP hGroup,
    LPCWSTR lpszGroupName,
    LPCWSTR lpszReason   // optional
);

パラメーター

名前方向説明
hGroupHGROUPin名前を変更する対象クラスターグループのハンドル。
lpszGroupNameLPCWSTRin設定する新しいグループ名を示すワイド文字列。
lpszReasonLPCWSTRinoptional操作の理由を示すワイド文字列。監査ログ用で、NULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

SetClusterGroupNameEx = ctypes.windll.clusapi.SetClusterGroupNameEx
SetClusterGroupNameEx.restype = wintypes.DWORD
SetClusterGroupNameEx.argtypes = [
    ctypes.c_ssize_t,  # hGroup : HGROUP
    wintypes.LPCWSTR,  # lpszGroupName : LPCWSTR
    wintypes.LPCWSTR,  # lpszReason : LPCWSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CLUSAPI.dll')
SetClusterGroupNameEx = Fiddle::Function.new(
  lib['SetClusterGroupNameEx'],
  [
    Fiddle::TYPE_INTPTR_T,  # hGroup : HGROUP
    Fiddle::TYPE_VOIDP,  # lpszGroupName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszReason : LPCWSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "clusapi")]
extern "system" {
    fn SetClusterGroupNameEx(
        hGroup: isize,  // HGROUP
        lpszGroupName: *const u16,  // LPCWSTR
        lpszReason: *const u16  // LPCWSTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint SetClusterGroupNameEx(IntPtr hGroup, [MarshalAs(UnmanagedType.LPWStr)] string lpszGroupName, [MarshalAs(UnmanagedType.LPWStr)] string lpszReason);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_SetClusterGroupNameEx' -Namespace Win32 -PassThru
# $api::SetClusterGroupNameEx(hGroup, lpszGroupName, lpszReason)
#uselib "CLUSAPI.dll"
#func global SetClusterGroupNameEx "SetClusterGroupNameEx" sptr, sptr, sptr
; SetClusterGroupNameEx hGroup, lpszGroupName, lpszReason   ; 戻り値は stat
; hGroup : HGROUP -> "sptr"
; lpszGroupName : LPCWSTR -> "sptr"
; lpszReason : LPCWSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "CLUSAPI.dll"
#cfunc global SetClusterGroupNameEx "SetClusterGroupNameEx" sptr, wstr, wstr
; res = SetClusterGroupNameEx(hGroup, lpszGroupName, lpszReason)
; hGroup : HGROUP -> "sptr"
; lpszGroupName : LPCWSTR -> "wstr"
; lpszReason : LPCWSTR optional -> "wstr"
; DWORD SetClusterGroupNameEx(HGROUP hGroup, LPCWSTR lpszGroupName, LPCWSTR lpszReason)
#uselib "CLUSAPI.dll"
#cfunc global SetClusterGroupNameEx "SetClusterGroupNameEx" intptr, wstr, wstr
; res = SetClusterGroupNameEx(hGroup, lpszGroupName, lpszReason)
; hGroup : HGROUP -> "intptr"
; lpszGroupName : LPCWSTR -> "wstr"
; lpszReason : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procSetClusterGroupNameEx = clusapi.NewProc("SetClusterGroupNameEx")
)

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

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

foreign import stdcall safe "SetClusterGroupNameEx"
  c_SetClusterGroupNameEx :: CIntPtr -> CWString -> CWString -> IO Word32
-- hGroup : HGROUP -> CIntPtr
-- lpszGroupName : LPCWSTR -> CWString
-- lpszReason : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setclustergroupnameex =
  foreign "SetClusterGroupNameEx"
    (intptr_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* hGroup : HGROUP -> intptr_t *)
(* lpszGroupName : LPCWSTR -> (ptr uint16_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 ("SetClusterGroupNameEx" set-cluster-group-name-ex :convention :stdcall) :uint32
  (h-group :int64)   ; HGROUP
  (lpsz-group-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lpsz-reason (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetClusterGroupNameEx = Win32::API::More->new('CLUSAPI',
    'DWORD SetClusterGroupNameEx(LPARAM hGroup, LPCWSTR lpszGroupName, LPCWSTR lpszReason)');
# my $ret = $SetClusterGroupNameEx->Call($hGroup, $lpszGroupName, $lpszReason);
# hGroup : HGROUP -> LPARAM
# lpszGroupName : LPCWSTR -> LPCWSTR
# lpszReason : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API