SHRegGetPathA

関数

レジストリ値からファイルパスを取得し環境変数を展開する。

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

シグネチャ

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

WIN32_ERROR SHRegGetPathA(
    HKEY hKey,
    LPCSTR pcszSubKey,   // optional
    LPCSTR pcszValue,   // optional
    LPSTR pszPath,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
hKey	HKEY	in	現在開いているキー、またはレジストリのルートキーへのハンドルです。
pcszSubKey	LPCSTR	inoptional	サブキーの名前を格納した null 終端文字列へのポインターです。
pcszValue	LPCSTR	inoptional	展開前のパス文字列を保持する値の名前を格納した null 終端文字列へのポインターです。
pszPath	LPSTR	out	展開後のパスを保持するバッファーです。返される文字列を格納するのに十分な大きさを確保するため、このバッファーのサイズは MAX_PATH に設定してください。
dwFlags	DWORD	in	予約済みです。

戻り値の型: WIN32_ERROR

公式ドキュメント

レジストリからファイルパスを取得し、必要に応じて環境変数を展開します。(ANSI)

戻り値

型: LSTATUS

成功した場合は ERROR_SUCCESS を、それ以外の場合は Windows エラーコードを返します。

解説(Remarks)

指定するレジストリ値のデータ型は、REG_EXPAND_SZ または REG_SZ のいずれかである必要があります。REG_EXPAND_SZ 型の場合、レジストリ文字列内の環境変数は ExpandEnvironmentStrings によって展開されます。REG_SZ データ型の場合、環境変数は展開されず、pszPath が指す文字列はレジストリ内の文字列と同一になります。

次の環境文字列は、それぞれに対応するパスに置き換えられます。

環境文字列	フォルダー
%USERPROFILE%	現在のユーザーのプロファイルフォルダー
%ALLUSERSPROFILE%	All Users プロファイルフォルダー
%ProgramFiles%	Program Files フォルダー
%SystemRoot%	システムルートフォルダー
%SystemDrive%	システムドライブのドライブ文字

注意 %USERPROFILE% は呼び出しを行うユーザーに対して相対的です。サービスからユーザーが偽装されている場合、この関数は動作しません。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SHRegGetPathA(
    HKEY hKey,
    LPCSTR pcszSubKey,   // optional
    LPCSTR pcszValue,   // optional
    LPSTR pszPath,
    DWORD dwFlags
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SHRegGetPathA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string pcszSubKey,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string pcszValue,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath,   // LPSTR out
    uint dwFlags   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegGetPathA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> pcszSubKey As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pcszValue As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder,   ' LPSTR out
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function

' hKey : HKEY
' pcszSubKey : LPCSTR optional
' pcszValue : LPCSTR optional
' pszPath : LPSTR out
' dwFlags : DWORD
Declare PtrSafe Function SHRegGetPathA Lib "shlwapi" ( _
    ByVal hKey As LongPtr, _
    ByVal pcszSubKey As String, _
    ByVal pcszValue As String, _
    ByVal pszPath As String, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHRegGetPathA = ctypes.windll.shlwapi.SHRegGetPathA
SHRegGetPathA.restype = wintypes.DWORD
SHRegGetPathA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # pcszSubKey : LPCSTR optional
    wintypes.LPCSTR,  # pcszValue : LPCSTR optional
    wintypes.LPSTR,  # pszPath : LPSTR out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegGetPathA = Fiddle::Function.new(
  lib['SHRegGetPathA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # pcszSubKey : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pcszValue : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pszPath : LPSTR out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn SHRegGetPathA(
        hKey: *mut core::ffi::c_void,  // HKEY
        pcszSubKey: *const u8,  // LPCSTR optional
        pcszValue: *const u8,  // LPCSTR optional
        pszPath: *mut u8,  // LPSTR out
        dwFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern uint SHRegGetPathA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string pcszSubKey, [MarshalAs(UnmanagedType.LPStr)] string pcszValue, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegGetPathA' -Namespace Win32 -PassThru
# $api::SHRegGetPathA(hKey, pcszSubKey, pcszValue, pszPath, dwFlags)

#uselib "SHLWAPI.dll"
#func global SHRegGetPathA "SHRegGetPathA" sptr, sptr, sptr, sptr, sptr
; SHRegGetPathA hKey, pcszSubKey, pcszValue, varptr(pszPath), dwFlags   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; pcszSubKey : LPCSTR optional -> "sptr"
; pcszValue : LPCSTR optional -> "sptr"
; pszPath : LPSTR out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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