ホーム › UI.Shell › SHRegQueryInfoUSKeyW

SHRegQueryInfoUSKeyW

関数

ユーザー単位レジストリキーのサブキー数や値数の情報を取得する。

DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR SHRegQueryInfoUSKeyW(
    INT_PTR hUSKey,
    DWORD* pcSubKeys,   // optional
    DWORD* pcchMaxSubKeyLen,   // optional
    DWORD* pcValues,   // optional
    DWORD* pcchMaxValueNameLen,   // optional
    SHREGENUM_FLAGS enumRegFlags
);

パラメーター

名前	型	方向	説明
hUSKey	INT_PTR	in	現在開いているレジストリサブキーへのハンドル。サブキーは KEY_SET_VALUE アクセス権で開かれている必要があります。詳細については、Registry Key Security and Access Rights を参照してください。このハンドルは SHRegOpenUSKey 関数を使用して取得できます。
pcSubKeys	DWORD*	outoptional	指定したキーの下にあるサブキーの数を受け取る DWORD へのポインター。
pcchMaxSubKeyLen	DWORD*	outoptional	最も長いサブキー名の文字数を受け取る DWORD へのポインター。
pcValues	DWORD*	outoptional	指定したキーの下にある値の数を受け取る DWORD へのポインター。
pcchMaxValueNameLen	DWORD*	outoptional	最も長い値の名前の文字数を受け取る DWORD へのポインター。
enumRegFlags	SHREGENUM_FLAGS	in	クエリを実行する基準キーを指定する SHREGENUM_FLAGS のいずれか。

戻り値の型: WIN32_ERROR

公式ドキュメント

ユーザー固有のサブツリー(HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE)内の指定したレジストリサブキーに関する情報を取得します。(Unicode)

戻り値

型: LSTATUS

成功した場合は ERROR_SUCCESS を返し、それ以外の場合は Winerror.h で定義されている 0 以外のエラーコードを返します。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーのテキスト形式の説明を取得できます。

解説(Remarks)

メモ

shlwapi.h ヘッダーは SHRegQueryInfoUSKey をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコードニュートラルなエイリアスの使用を、エンコードニュートラルではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR SHRegQueryInfoUSKeyW(
    INT_PTR hUSKey,
    DWORD* pcSubKeys,   // optional
    DWORD* pcchMaxSubKeyLen,   // optional
    DWORD* pcValues,   // optional
    DWORD* pcchMaxValueNameLen,   // optional
    SHREGENUM_FLAGS enumRegFlags
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegQueryInfoUSKeyW(
    IntPtr hUSKey,   // INT_PTR
    IntPtr pcSubKeys,   // DWORD* optional, out
    IntPtr pcchMaxSubKeyLen,   // DWORD* optional, out
    IntPtr pcValues,   // DWORD* optional, out
    IntPtr pcchMaxValueNameLen,   // DWORD* optional, out
    int enumRegFlags   // SHREGENUM_FLAGS
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegQueryInfoUSKeyW(
    hUSKey As IntPtr,   ' INT_PTR
    pcSubKeys As IntPtr,   ' DWORD* optional, out
    pcchMaxSubKeyLen As IntPtr,   ' DWORD* optional, out
    pcValues As IntPtr,   ' DWORD* optional, out
    pcchMaxValueNameLen As IntPtr,   ' DWORD* optional, out
    enumRegFlags As Integer   ' SHREGENUM_FLAGS
) As UInteger
End Function

' hUSKey : INT_PTR
' pcSubKeys : DWORD* optional, out
' pcchMaxSubKeyLen : DWORD* optional, out
' pcValues : DWORD* optional, out
' pcchMaxValueNameLen : DWORD* optional, out
' enumRegFlags : SHREGENUM_FLAGS
Declare PtrSafe Function SHRegQueryInfoUSKeyW Lib "shlwapi" ( _
    ByVal hUSKey As LongPtr, _
    ByVal pcSubKeys As LongPtr, _
    ByVal pcchMaxSubKeyLen As LongPtr, _
    ByVal pcValues As LongPtr, _
    ByVal pcchMaxValueNameLen As LongPtr, _
    ByVal enumRegFlags As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHRegQueryInfoUSKeyW = ctypes.windll.shlwapi.SHRegQueryInfoUSKeyW
SHRegQueryInfoUSKeyW.restype = wintypes.DWORD
SHRegQueryInfoUSKeyW.argtypes = [
    ctypes.c_ssize_t,  # hUSKey : INT_PTR
    ctypes.POINTER(wintypes.DWORD),  # pcSubKeys : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchMaxSubKeyLen : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcValues : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchMaxValueNameLen : DWORD* optional, out
    ctypes.c_int,  # enumRegFlags : SHREGENUM_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegQueryInfoUSKeyW = Fiddle::Function.new(
  lib['SHRegQueryInfoUSKeyW'],
  [
    Fiddle::TYPE_INTPTR_T,  # hUSKey : INT_PTR
    Fiddle::TYPE_VOIDP,  # pcSubKeys : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pcchMaxSubKeyLen : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pcValues : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pcchMaxValueNameLen : DWORD* optional, out
    Fiddle::TYPE_INT,  # enumRegFlags : SHREGENUM_FLAGS
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegQueryInfoUSKeyW(
        hUSKey: isize,  // INT_PTR
        pcSubKeys: *mut u32,  // DWORD* optional, out
        pcchMaxSubKeyLen: *mut u32,  // DWORD* optional, out
        pcValues: *mut u32,  // DWORD* optional, out
        pcchMaxValueNameLen: *mut u32,  // DWORD* optional, out
        enumRegFlags: i32  // SHREGENUM_FLAGS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint SHRegQueryInfoUSKeyW(IntPtr hUSKey, IntPtr pcSubKeys, IntPtr pcchMaxSubKeyLen, IntPtr pcValues, IntPtr pcchMaxValueNameLen, int enumRegFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegQueryInfoUSKeyW' -Namespace Win32 -PassThru
# $api::SHRegQueryInfoUSKeyW(hUSKey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen, enumRegFlags)

#uselib "SHLWAPI.dll"
#func global SHRegQueryInfoUSKeyW "SHRegQueryInfoUSKeyW" wptr, wptr, wptr, wptr, wptr, wptr
; SHRegQueryInfoUSKeyW hUSKey, varptr(pcSubKeys), varptr(pcchMaxSubKeyLen), varptr(pcValues), varptr(pcchMaxValueNameLen), enumRegFlags   ; 戻り値は stat
; hUSKey : INT_PTR -> "wptr"
; pcSubKeys : DWORD* optional, out -> "wptr"
; pcchMaxSubKeyLen : DWORD* optional, out -> "wptr"
; pcValues : DWORD* optional, out -> "wptr"
; pcchMaxValueNameLen : DWORD* optional, out -> "wptr"
; enumRegFlags : SHREGENUM_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHRegQueryInfoUSKeyW "SHRegQueryInfoUSKeyW" sptr, var, var, var, var, int
; res = SHRegQueryInfoUSKeyW(hUSKey, pcSubKeys, pcchMaxSubKeyLen, pcValues, pcchMaxValueNameLen, enumRegFlags)
; hUSKey : INT_PTR -> "sptr"
; pcSubKeys : DWORD* optional, out -> "var"
; pcchMaxSubKeyLen : DWORD* optional, out -> "var"
; pcValues : DWORD* optional, out -> "var"
; pcchMaxValueNameLen : DWORD* optional, out -> "var"
; enumRegFlags : SHREGENUM_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHRegQueryInfoUSKeyW "SHRegQueryInfoUSKeyW" sptr, sptr, sptr, sptr, sptr, int
; res = SHRegQueryInfoUSKeyW(hUSKey, varptr(pcSubKeys), varptr(pcchMaxSubKeyLen), varptr(pcValues), varptr(pcchMaxValueNameLen), enumRegFlags)
; hUSKey : INT_PTR -> "sptr"
; pcSubKeys : DWORD* optional, out -> "sptr"
; pcchMaxSubKeyLen : DWORD* optional, out -> "sptr"
; pcValues : DWORD* optional, out -> "sptr"
; pcchMaxValueNameLen : DWORD* optional, out -> "sptr"
; enumRegFlags : SHREGENUM_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。