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

ClusterGroupEnum

関数
グループ列挙から指定インデックスのリソース名と種別を取得する。
DLLCLUSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD ClusterGroupEnum(
    HGROUPENUM hGroupEnum,
    DWORD dwIndex,
    DWORD* lpdwType,
    LPWSTR lpszResourceName,
    DWORD* lpcchName
);

パラメーター

名前方向説明
hGroupEnumHGROUPENUMinClusterGroupOpenEnumで取得したグループ列挙ハンドル。
dwIndexDWORDin取得する要素の0始まりのインデックス。0から順に列挙する。
lpdwTypeDWORD*out返される項目の種別を受け取るDWORDへのポインタ。
lpszResourceNameLPWSTRout列挙したリソース名を受け取るワイド文字列バッファ。NULLでサイズ取得可。
lpcchNameDWORD*inoutlpszResourceNameの文字数を入出力する。終端NULを含まない文字数が返る。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

ClusterGroupEnum = ctypes.windll.clusapi.ClusterGroupEnum
ClusterGroupEnum.restype = wintypes.DWORD
ClusterGroupEnum.argtypes = [
    ctypes.c_ssize_t,  # hGroupEnum : HGROUPENUM
    wintypes.DWORD,  # dwIndex : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpdwType : DWORD* out
    wintypes.LPWSTR,  # lpszResourceName : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpcchName : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procClusterGroupEnum = clusapi.NewProc("ClusterGroupEnum")
)

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

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

typedef ClusterGroupEnumNative = Uint32 Function(IntPtr, Uint32, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>);
typedef ClusterGroupEnumDart = int Function(int, int, Pointer<Uint32>, Pointer<Utf16>, Pointer<Uint32>);
final ClusterGroupEnum = DynamicLibrary.open('CLUSAPI.dll')
    .lookupFunction<ClusterGroupEnumNative, ClusterGroupEnumDart>('ClusterGroupEnum');
// hGroupEnum : HGROUPENUM -> IntPtr
// dwIndex : DWORD -> Uint32
// lpdwType : DWORD* out -> Pointer<Uint32>
// lpszResourceName : LPWSTR out -> Pointer<Utf16>
// lpcchName : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ClusterGroupEnum(
  hGroupEnum: NativeInt;   // HGROUPENUM
  dwIndex: DWORD;   // DWORD
  lpdwType: Pointer;   // DWORD* out
  lpszResourceName: PWideChar;   // LPWSTR out
  lpcchName: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'ClusterGroupEnum';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ClusterGroupEnum"
  c_ClusterGroupEnum :: CIntPtr -> Word32 -> Ptr Word32 -> CWString -> Ptr Word32 -> IO Word32
-- hGroupEnum : HGROUPENUM -> CIntPtr
-- dwIndex : DWORD -> Word32
-- lpdwType : DWORD* out -> Ptr Word32
-- lpszResourceName : LPWSTR out -> CWString
-- lpcchName : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let clustergroupenum =
  foreign "ClusterGroupEnum"
    (intptr_t @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hGroupEnum : HGROUPENUM -> intptr_t *)
(* dwIndex : DWORD -> uint32_t *)
(* lpdwType : DWORD* out -> (ptr uint32_t) *)
(* lpszResourceName : LPWSTR out -> (ptr uint16_t) *)
(* lpcchName : DWORD* in/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 ("ClusterGroupEnum" cluster-group-enum :convention :stdcall) :uint32
  (h-group-enum :int64)   ; HGROUPENUM
  (dw-index :uint32)   ; DWORD
  (lpdw-type :pointer)   ; DWORD* out
  (lpsz-resource-name :pointer)   ; LPWSTR out
  (lpcch-name :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ClusterGroupEnum = Win32::API::More->new('CLUSAPI',
    'DWORD ClusterGroupEnum(LPARAM hGroupEnum, DWORD dwIndex, LPVOID lpdwType, LPWSTR lpszResourceName, LPVOID lpcchName)');
# my $ret = $ClusterGroupEnum->Call($hGroupEnum, $dwIndex, $lpdwType, $lpszResourceName, $lpcchName);
# hGroupEnum : HGROUPENUM -> LPARAM
# dwIndex : DWORD -> DWORD
# lpdwType : DWORD* out -> LPVOID
# lpszResourceName : LPWSTR out -> LPWSTR
# lpcchName : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API