SHRegOpenUSKeyA

関数

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

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

シグネチャ

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR SHRegOpenUSKeyA(
    LPCSTR pszPath,
    DWORD samDesired,
    INT_PTR hRelativeUSKey,   // optional
    INT_PTR* phNewUSKey,
    BOOL fIgnoreHKCU
);

パラメーター

名前	型	方向	説明
pszPath	LPCSTR	in	サブキーの名前を含む null 終端文字列へのポインター。
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 から値を返します。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

型: LSTATUS

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

解説(Remarks)

メモ

shlwapi.h ヘッダーは、SHRegOpenUSKey をエイリアスとして定義しており、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  (ANSI / -A)
#include <windows.h>

WIN32_ERROR SHRegOpenUSKeyA(
    LPCSTR pszPath,
    DWORD samDesired,
    INT_PTR hRelativeUSKey,   // optional
    INT_PTR* phNewUSKey,
    BOOL fIgnoreHKCU
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegOpenUSKeyA(
    [MarshalAs(UnmanagedType.LPStr)] string pszPath,   // LPCSTR
    uint samDesired,   // DWORD
    IntPtr hRelativeUSKey,   // INT_PTR optional
    out IntPtr phNewUSKey,   // INT_PTR* out
    bool fIgnoreHKCU   // BOOL
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegOpenUSKeyA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String,   ' LPCSTR
    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

' pszPath : LPCSTR
' samDesired : DWORD
' hRelativeUSKey : INT_PTR optional
' phNewUSKey : INT_PTR* out
' fIgnoreHKCU : BOOL
Declare PtrSafe Function SHRegOpenUSKeyA Lib "shlwapi" ( _
    ByVal pszPath As String, _
    ByVal samDesired As Long, _
    ByVal hRelativeUSKey As LongPtr, _
    ByRef phNewUSKey As LongPtr, _
    ByVal fIgnoreHKCU As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHRegOpenUSKeyA = ctypes.windll.shlwapi.SHRegOpenUSKeyA
SHRegOpenUSKeyA.restype = wintypes.DWORD
SHRegOpenUSKeyA.argtypes = [
    wintypes.LPCSTR,  # pszPath : LPCSTR
    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')
SHRegOpenUSKeyA = Fiddle::Function.new(
  lib['SHRegOpenUSKeyA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCSTR
    -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)

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegOpenUSKeyA(
        pszPath: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint SHRegOpenUSKeyA([MarshalAs(UnmanagedType.LPStr)] string pszPath, uint samDesired, IntPtr hRelativeUSKey, out IntPtr phNewUSKey, bool fIgnoreHKCU);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegOpenUSKeyA' -Namespace Win32 -PassThru
# $api::SHRegOpenUSKeyA(pszPath, samDesired, hRelativeUSKey, phNewUSKey, fIgnoreHKCU)

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

出力引数:

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