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

ResUtilEnumPrivateProperties

関数
クラスタキーのプライベートプロパティ名を列挙する。
DLLRESUTILS.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD ResUtilEnumPrivateProperties(
    HKEY hkeyClusterKey,
    LPWSTR pszOutProperties,
    DWORD cbOutPropertiesSize,
    DWORD* pcbBytesReturned,
    DWORD* pcbRequired
);

パラメーター

名前方向説明
hkeyClusterKeyHKEYinプライベートプロパティを列挙する対象のクラスターレジストリキー。
pszOutPropertiesLPWSTRout列挙したプロパティ名一覧を受け取る出力バッファ。
cbOutPropertiesSizeDWORDinpszOutPropertiesのサイズ(バイト)。
pcbBytesReturnedDWORD*out出力に書き込まれた実バイト数を受け取るDWORDポインタ。
pcbRequiredDWORD*out必要なバッファのバイト数を受け取るDWORDポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ResUtilEnumPrivateProperties(
    HKEY hkeyClusterKey,
    LPWSTR pszOutProperties,
    DWORD cbOutPropertiesSize,
    DWORD* pcbBytesReturned,
    DWORD* pcbRequired
);
[DllImport("RESUTILS.dll", ExactSpelling = true)]
static extern uint ResUtilEnumPrivateProperties(
    IntPtr hkeyClusterKey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOutProperties,   // LPWSTR out
    uint cbOutPropertiesSize,   // DWORD
    out uint pcbBytesReturned,   // DWORD* out
    out uint pcbRequired   // DWORD* out
);
<DllImport("RESUTILS.dll", ExactSpelling:=True)>
Public Shared Function ResUtilEnumPrivateProperties(
    hkeyClusterKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> pszOutProperties As System.Text.StringBuilder,   ' LPWSTR out
    cbOutPropertiesSize As UInteger,   ' DWORD
    <Out> ByRef pcbBytesReturned As UInteger,   ' DWORD* out
    <Out> ByRef pcbRequired As UInteger   ' DWORD* out
) As UInteger
End Function
' hkeyClusterKey : HKEY
' pszOutProperties : LPWSTR out
' cbOutPropertiesSize : DWORD
' pcbBytesReturned : DWORD* out
' pcbRequired : DWORD* out
Declare PtrSafe Function ResUtilEnumPrivateProperties Lib "resutils" ( _
    ByVal hkeyClusterKey As LongPtr, _
    ByVal pszOutProperties As LongPtr, _
    ByVal cbOutPropertiesSize As Long, _
    ByRef pcbBytesReturned As Long, _
    ByRef pcbRequired As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ResUtilEnumPrivateProperties = ctypes.windll.resutils.ResUtilEnumPrivateProperties
ResUtilEnumPrivateProperties.restype = wintypes.DWORD
ResUtilEnumPrivateProperties.argtypes = [
    wintypes.HANDLE,  # hkeyClusterKey : HKEY
    wintypes.LPWSTR,  # pszOutProperties : LPWSTR out
    wintypes.DWORD,  # cbOutPropertiesSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbBytesReturned : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # pcbRequired : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	resutils = windows.NewLazySystemDLL("RESUTILS.dll")
	procResUtilEnumPrivateProperties = resutils.NewProc("ResUtilEnumPrivateProperties")
)

// hkeyClusterKey (HKEY), pszOutProperties (LPWSTR out), cbOutPropertiesSize (DWORD), pcbBytesReturned (DWORD* out), pcbRequired (DWORD* out)
r1, _, err := procResUtilEnumPrivateProperties.Call(
	uintptr(hkeyClusterKey),
	uintptr(pszOutProperties),
	uintptr(cbOutPropertiesSize),
	uintptr(pcbBytesReturned),
	uintptr(pcbRequired),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ResUtilEnumPrivateProperties(
  hkeyClusterKey: THandle;   // HKEY
  pszOutProperties: PWideChar;   // LPWSTR out
  cbOutPropertiesSize: DWORD;   // DWORD
  pcbBytesReturned: Pointer;   // DWORD* out
  pcbRequired: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'RESUTILS.dll' name 'ResUtilEnumPrivateProperties';
result := DllCall("RESUTILS\ResUtilEnumPrivateProperties"
    , "Ptr", hkeyClusterKey   ; HKEY
    , "Ptr", pszOutProperties   ; LPWSTR out
    , "UInt", cbOutPropertiesSize   ; DWORD
    , "Ptr", pcbBytesReturned   ; DWORD* out
    , "Ptr", pcbRequired   ; DWORD* out
    , "UInt")   ; return: DWORD
●ResUtilEnumPrivateProperties(hkeyClusterKey, pszOutProperties, cbOutPropertiesSize, pcbBytesReturned, pcbRequired) = DLL("RESUTILS.dll", "dword ResUtilEnumPrivateProperties(void*, char*, dword, void*, void*)")
# 呼び出し: ResUtilEnumPrivateProperties(hkeyClusterKey, pszOutProperties, cbOutPropertiesSize, pcbBytesReturned, pcbRequired)
# hkeyClusterKey : HKEY -> "void*"
# pszOutProperties : LPWSTR out -> "char*"
# cbOutPropertiesSize : DWORD -> "dword"
# pcbBytesReturned : DWORD* out -> "void*"
# pcbRequired : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ResUtilEnumPrivatePropertiesNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Uint32>, Pointer<Uint32>);
typedef ResUtilEnumPrivatePropertiesDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Uint32>);
final ResUtilEnumPrivateProperties = DynamicLibrary.open('RESUTILS.dll')
    .lookupFunction<ResUtilEnumPrivatePropertiesNative, ResUtilEnumPrivatePropertiesDart>('ResUtilEnumPrivateProperties');
// hkeyClusterKey : HKEY -> Pointer<Void>
// pszOutProperties : LPWSTR out -> Pointer<Utf16>
// cbOutPropertiesSize : DWORD -> Uint32
// pcbBytesReturned : DWORD* out -> Pointer<Uint32>
// pcbRequired : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ResUtilEnumPrivateProperties(
  hkeyClusterKey: THandle;   // HKEY
  pszOutProperties: PWideChar;   // LPWSTR out
  cbOutPropertiesSize: DWORD;   // DWORD
  pcbBytesReturned: Pointer;   // DWORD* out
  pcbRequired: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'RESUTILS.dll' name 'ResUtilEnumPrivateProperties';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ResUtilEnumPrivateProperties"
  c_ResUtilEnumPrivateProperties :: Ptr () -> CWString -> Word32 -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- hkeyClusterKey : HKEY -> Ptr ()
-- pszOutProperties : LPWSTR out -> CWString
-- cbOutPropertiesSize : DWORD -> Word32
-- pcbBytesReturned : DWORD* out -> Ptr Word32
-- pcbRequired : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let resutilenumprivateproperties =
  foreign "ResUtilEnumPrivateProperties"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hkeyClusterKey : HKEY -> (ptr void) *)
(* pszOutProperties : LPWSTR out -> (ptr uint16_t) *)
(* cbOutPropertiesSize : DWORD -> uint32_t *)
(* pcbBytesReturned : DWORD* out -> (ptr uint32_t) *)
(* pcbRequired : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library resutils (t "RESUTILS.dll"))
(cffi:use-foreign-library resutils)

(cffi:defcfun ("ResUtilEnumPrivateProperties" res-util-enum-private-properties :convention :stdcall) :uint32
  (hkey-cluster-key :pointer)   ; HKEY
  (psz-out-properties :pointer)   ; LPWSTR out
  (cb-out-properties-size :uint32)   ; DWORD
  (pcb-bytes-returned :pointer)   ; DWORD* out
  (pcb-required :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ResUtilEnumPrivateProperties = Win32::API::More->new('RESUTILS',
    'DWORD ResUtilEnumPrivateProperties(HANDLE hkeyClusterKey, LPWSTR pszOutProperties, DWORD cbOutPropertiesSize, LPVOID pcbBytesReturned, LPVOID pcbRequired)');
# my $ret = $ResUtilEnumPrivateProperties->Call($hkeyClusterKey, $pszOutProperties, $cbOutPropertiesSize, $pcbBytesReturned, $pcbRequired);
# hkeyClusterKey : HKEY -> HANDLE
# pszOutProperties : LPWSTR out -> LPWSTR
# cbOutPropertiesSize : DWORD -> DWORD
# pcbBytesReturned : DWORD* out -> LPVOID
# pcbRequired : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。