SHRegOpenUSKeyW

関数

HKCUとHKLMを統合するユーザー単位レジストリキーを開く。

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

シグネチャ

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

WIN32_ERROR SHRegOpenUSKeyW(
    LPCWSTR pwzPath,
    DWORD samDesired,
    INT_PTR hRelativeUSKey,   // optional
    INT_PTR* phNewUSKey,
    BOOL fIgnoreHKCU
);

パラメーター

名前	型	方向	説明
pwzPath	LPCWSTR	in	TBD
samDesired	DWORD	in	要求するセキュリティアクセスです。セキュリティアクセスの詳細については、REGSAM を参照してください。
hRelativeUSKey	INT_PTR	inoptional	相対パスの基準として使用するキーです。pszPath が相対パスの場合、それが指定するキーは hRelativeUSKey からの相対になります。pszPath が絶対パスの場合は、hRelativeUSKey に NULL を設定します。
phNewUSKey	INT_PTR*	out	開かれたキーのハンドルへのポインターです。
fIgnoreHKCU	BOOL	in	どのキーを参照するかを指定する変数です。TRUE に設定すると、SHRegOpenUSKey は HKEY_CURRENT_USER を無視し、HKEY_LOCAL_MACHINE から値を返します。 - pszPath [in] 型: LPCTSTR サブキーの名前を含む、null 終端文字列へのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

ユーザー固有のサブツリー(HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE)内のレジストリサブキーを開きます。(Unicode)

戻り値

型: LSTATUS

成功した場合は ERROR_SUCCESS を返し、それ以外の場合は Winerror.h で定義されている 0 以外のエラーコードを返します。FORMAT_MESSAGE_FROM_SYSTEM フラグを指定して FormatMessage 関数を使用すると、エラーの一般的な説明を取得できます。

解説(Remarks)

メモ

shlwapi.h ヘッダーは、SHRegOpenUSKey を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコード非依存のエイリアスの使用を、エンコード非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SHRegOpenUSKeyW(
    LPCWSTR pwzPath,
    DWORD samDesired,
    INT_PTR hRelativeUSKey,   // optional
    INT_PTR* phNewUSKey,
    BOOL fIgnoreHKCU
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SHRegOpenUSKeyW(
    [MarshalAs(UnmanagedType.LPWStr)] string pwzPath,   // LPCWSTR
    uint samDesired,   // DWORD
    IntPtr hRelativeUSKey,   // INT_PTR optional
    out IntPtr phNewUSKey,   // INT_PTR* out
    bool fIgnoreHKCU   // BOOL
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegOpenUSKeyW(
    <MarshalAs(UnmanagedType.LPWStr)> pwzPath As String,   ' LPCWSTR
    samDesired As UInteger,   ' DWORD
    hRelativeUSKey As IntPtr,   ' INT_PTR optional
    <Out> ByRef phNewUSKey As IntPtr,   ' INT_PTR* out
    fIgnoreHKCU As Boolean   ' BOOL
) As UInteger
End Function

' pwzPath : LPCWSTR
' samDesired : DWORD
' hRelativeUSKey : INT_PTR optional
' phNewUSKey : INT_PTR* out
' fIgnoreHKCU : BOOL
Declare PtrSafe Function SHRegOpenUSKeyW Lib "shlwapi" ( _
    ByVal pwzPath As LongPtr, _
    ByVal samDesired As Long, _
    ByVal hRelativeUSKey As LongPtr, _
    ByRef phNewUSKey As LongPtr, _
    ByVal fIgnoreHKCU 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

SHRegOpenUSKeyW = ctypes.windll.shlwapi.SHRegOpenUSKeyW
SHRegOpenUSKeyW.restype = wintypes.DWORD
SHRegOpenUSKeyW.argtypes = [
    wintypes.LPCWSTR,  # pwzPath : LPCWSTR
    wintypes.DWORD,  # samDesired : DWORD
    ctypes.c_ssize_t,  # hRelativeUSKey : INT_PTR optional
    ctypes.POINTER(ctypes.c_ssize_t),  # phNewUSKey : INT_PTR* out
    wintypes.BOOL,  # fIgnoreHKCU : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegOpenUSKeyW = Fiddle::Function.new(
  lib['SHRegOpenUSKeyW'],
  [
    Fiddle::TYPE_VOIDP,  # pwzPath : LPCWSTR
    -Fiddle::TYPE_INT,  # samDesired : DWORD
    Fiddle::TYPE_INTPTR_T,  # hRelativeUSKey : INT_PTR optional
    Fiddle::TYPE_VOIDP,  # phNewUSKey : INT_PTR* out
    Fiddle::TYPE_INT,  # fIgnoreHKCU : BOOL
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegOpenUSKeyW(
        pwzPath: *const u16,  // LPCWSTR
        samDesired: u32,  // DWORD
        hRelativeUSKey: isize,  // INT_PTR optional
        phNewUSKey: *mut isize,  // INT_PTR* out
        fIgnoreHKCU: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint SHRegOpenUSKeyW([MarshalAs(UnmanagedType.LPWStr)] string pwzPath, uint samDesired, IntPtr hRelativeUSKey, out IntPtr phNewUSKey, bool fIgnoreHKCU);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegOpenUSKeyW' -Namespace Win32 -PassThru
# $api::SHRegOpenUSKeyW(pwzPath, samDesired, hRelativeUSKey, phNewUSKey, fIgnoreHKCU)

#uselib "SHLWAPI.dll"
#func global SHRegOpenUSKeyW "SHRegOpenUSKeyW" wptr, wptr, wptr, wptr, wptr
; SHRegOpenUSKeyW pwzPath, samDesired, hRelativeUSKey, varptr(phNewUSKey), fIgnoreHKCU   ; 戻り値は stat
; pwzPath : LPCWSTR -> "wptr"
; samDesired : DWORD -> "wptr"
; hRelativeUSKey : INT_PTR optional -> "wptr"
; phNewUSKey : INT_PTR* out -> "wptr"
; fIgnoreHKCU : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global SHRegOpenUSKeyW "SHRegOpenUSKeyW" wstr, int, sptr, var, int
; res = SHRegOpenUSKeyW(pwzPath, samDesired, hRelativeUSKey, phNewUSKey, fIgnoreHKCU)
; pwzPath : LPCWSTR -> "wstr"
; samDesired : DWORD -> "int"
; hRelativeUSKey : INT_PTR optional -> "sptr"
; phNewUSKey : INT_PTR* out -> "var"
; fIgnoreHKCU : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global SHRegOpenUSKeyW "SHRegOpenUSKeyW" wstr, int, sptr, sptr, int
; res = SHRegOpenUSKeyW(pwzPath, samDesired, hRelativeUSKey, varptr(phNewUSKey), fIgnoreHKCU)
; pwzPath : LPCWSTR -> "wstr"
; samDesired : DWORD -> "int"
; hRelativeUSKey : INT_PTR optional -> "sptr"
; phNewUSKey : INT_PTR* out -> "sptr"
; fIgnoreHKCU : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。