Win32 API 日本語リファレンス
ホームUI.Shell › SHRegGetBoolUSValueW

SHRegGetBoolUSValueW

関数
ユーザー単位レジストリ値を真偽値として取得する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL SHRegGetBoolUSValueW(
    LPCWSTR pszSubKey,
    LPCWSTR pszValue,   // optional
    BOOL fIgnoreHKCU,
    BOOL fDefault
);

パラメーター

名前方向説明
pszSubKeyLPCWSTRinHKEY_LOCAL_MACHINE および HKEY_CURRENT_USER からの相対的なサブキー名を含む、null で終わる文字列へのポインターです。例: "Software\MyCompany\MyProduct"。
pszValueLPCWSTRinoptional値の名前を指定する、null で終わる文字列へのポインターです。この値は NULL にすることができます。
fIgnoreHKCUBOOLinどのキーを参照するかを指定する変数です。TRUE に設定すると、SHRegGetUSValueHKEY_CURRENT_USER を無視し、HKEY_LOCAL_MACHINE から値を返します。
fDefaultBOOLinレジストリ値が存在しない場合に返される値です。

戻り値の型: BOOL

公式ドキュメント

ユーザー固有のサブツリー(HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE)内のレジストリサブキーから Boolean 値を取得します。(Unicode)

戻り値

型: BOOL

レジストリからの値、または値が見つからない場合は fDefault を返します。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL SHRegGetBoolUSValueW(
    LPCWSTR pszSubKey,
    LPCWSTR pszValue,   // optional
    BOOL fIgnoreHKCU,
    BOOL fDefault
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SHRegGetBoolUSValueW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszSubKey,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszValue,   // LPCWSTR optional
    bool fIgnoreHKCU,   // BOOL
    bool fDefault   // BOOL
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHRegGetBoolUSValueW(
    <MarshalAs(UnmanagedType.LPWStr)> pszSubKey As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszValue As String,   ' LPCWSTR optional
    fIgnoreHKCU As Boolean,   ' BOOL
    fDefault As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszSubKey : LPCWSTR
' pszValue : LPCWSTR optional
' fIgnoreHKCU : BOOL
' fDefault : BOOL
Declare PtrSafe Function SHRegGetBoolUSValueW Lib "shlwapi" ( _
    ByVal pszSubKey As LongPtr, _
    ByVal pszValue As LongPtr, _
    ByVal fIgnoreHKCU As Long, _
    ByVal fDefault 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

SHRegGetBoolUSValueW = ctypes.windll.shlwapi.SHRegGetBoolUSValueW
SHRegGetBoolUSValueW.restype = wintypes.BOOL
SHRegGetBoolUSValueW.argtypes = [
    wintypes.LPCWSTR,  # pszSubKey : LPCWSTR
    wintypes.LPCWSTR,  # pszValue : LPCWSTR optional
    wintypes.BOOL,  # fIgnoreHKCU : BOOL
    wintypes.BOOL,  # fDefault : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegGetBoolUSValueW = Fiddle::Function.new(
  lib['SHRegGetBoolUSValueW'],
  [
    Fiddle::TYPE_VOIDP,  # pszSubKey : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszValue : LPCWSTR optional
    Fiddle::TYPE_INT,  # fIgnoreHKCU : BOOL
    Fiddle::TYPE_INT,  # fDefault : BOOL
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn SHRegGetBoolUSValueW(
        pszSubKey: *const u16,  // LPCWSTR
        pszValue: *const u16,  // LPCWSTR optional
        fIgnoreHKCU: i32,  // BOOL
        fDefault: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern bool SHRegGetBoolUSValueW([MarshalAs(UnmanagedType.LPWStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPWStr)] string pszValue, bool fIgnoreHKCU, bool fDefault);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegGetBoolUSValueW' -Namespace Win32 -PassThru
# $api::SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
#uselib "SHLWAPI.dll"
#func global SHRegGetBoolUSValueW "SHRegGetBoolUSValueW" wptr, wptr, wptr, wptr
; SHRegGetBoolUSValueW pszSubKey, pszValue, fIgnoreHKCU, fDefault   ; 戻り値は stat
; pszSubKey : LPCWSTR -> "wptr"
; pszValue : LPCWSTR optional -> "wptr"
; fIgnoreHKCU : BOOL -> "wptr"
; fDefault : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetBoolUSValueW "SHRegGetBoolUSValueW" wstr, wstr, int, int
; res = SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
; pszSubKey : LPCWSTR -> "wstr"
; pszValue : LPCWSTR optional -> "wstr"
; fIgnoreHKCU : BOOL -> "int"
; fDefault : BOOL -> "int"
; BOOL SHRegGetBoolUSValueW(LPCWSTR pszSubKey, LPCWSTR pszValue, BOOL fIgnoreHKCU, BOOL fDefault)
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetBoolUSValueW "SHRegGetBoolUSValueW" wstr, wstr, int, int
; res = SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
; pszSubKey : LPCWSTR -> "wstr"
; pszValue : LPCWSTR optional -> "wstr"
; fIgnoreHKCU : BOOL -> "int"
; fDefault : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHRegGetBoolUSValueW = shlwapi.NewProc("SHRegGetBoolUSValueW")
)

// pszSubKey (LPCWSTR), pszValue (LPCWSTR optional), fIgnoreHKCU (BOOL), fDefault (BOOL)
r1, _, err := procSHRegGetBoolUSValueW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszSubKey))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszValue))),
	uintptr(fIgnoreHKCU),
	uintptr(fDefault),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHRegGetBoolUSValueW(
  pszSubKey: PWideChar;   // LPCWSTR
  pszValue: PWideChar;   // LPCWSTR optional
  fIgnoreHKCU: BOOL;   // BOOL
  fDefault: BOOL   // BOOL
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'SHRegGetBoolUSValueW';
result := DllCall("SHLWAPI\SHRegGetBoolUSValueW"
    , "WStr", pszSubKey   ; LPCWSTR
    , "WStr", pszValue   ; LPCWSTR optional
    , "Int", fIgnoreHKCU   ; BOOL
    , "Int", fDefault   ; BOOL
    , "Int")   ; return: BOOL
●SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault) = DLL("SHLWAPI.dll", "bool SHRegGetBoolUSValueW(char*, char*, bool, bool)")
# 呼び出し: SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
# pszSubKey : LPCWSTR -> "char*"
# pszValue : LPCWSTR optional -> "char*"
# fIgnoreHKCU : BOOL -> "bool"
# fDefault : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn SHRegGetBoolUSValueW(
    pszSubKey: [*c]const u16, // LPCWSTR
    pszValue: [*c]const u16, // LPCWSTR optional
    fIgnoreHKCU: i32, // BOOL
    fDefault: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHRegGetBoolUSValueW(
    pszSubKey: WideCString,  # LPCWSTR
    pszValue: WideCString,  # LPCWSTR optional
    fIgnoreHKCU: int32,  # BOOL
    fDefault: int32  # BOOL
): int32 {.importc: "SHRegGetBoolUSValueW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int SHRegGetBoolUSValueW(
    const(wchar)* pszSubKey,   // LPCWSTR
    const(wchar)* pszValue,   // LPCWSTR optional
    int fIgnoreHKCU,   // BOOL
    int fDefault   // BOOL
);
ccall((:SHRegGetBoolUSValueW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Int32, Int32),
      pszSubKey, pszValue, fIgnoreHKCU, fDefault)
# pszSubKey : LPCWSTR -> Cwstring
# pszValue : LPCWSTR optional -> Cwstring
# fIgnoreHKCU : BOOL -> Int32
# fDefault : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHRegGetBoolUSValueW(
    const uint16_t* pszSubKey,
    const uint16_t* pszValue,
    int32_t fIgnoreHKCU,
    int32_t fDefault);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
-- pszSubKey : LPCWSTR
-- pszValue : LPCWSTR optional
-- fIgnoreHKCU : BOOL
-- fDefault : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHRegGetBoolUSValueW = lib.func('__stdcall', 'SHRegGetBoolUSValueW', 'int32_t', ['str16', 'str16', 'int32_t', 'int32_t']);
// SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
// pszSubKey : LPCWSTR -> 'str16'
// pszValue : LPCWSTR optional -> 'str16'
// fIgnoreHKCU : BOOL -> 'int32_t'
// fDefault : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHRegGetBoolUSValueW: { parameters: ["buffer", "buffer", "i32", "i32"], result: "i32" },
});
// lib.symbols.SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
// pszSubKey : LPCWSTR -> "buffer"
// pszValue : LPCWSTR optional -> "buffer"
// fIgnoreHKCU : BOOL -> "i32"
// fDefault : BOOL -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHRegGetBoolUSValueW(
    const uint16_t* pszSubKey,
    const uint16_t* pszValue,
    int32_t fIgnoreHKCU,
    int32_t fDefault);
C, "SHLWAPI.dll");
// $ffi->SHRegGetBoolUSValueW(pszSubKey, pszValue, fIgnoreHKCU, fDefault);
// pszSubKey : LPCWSTR
// pszValue : LPCWSTR optional
// fIgnoreHKCU : BOOL
// fDefault : BOOL
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SHRegGetBoolUSValueW(
        WString pszSubKey,   // LPCWSTR
        WString pszValue,   // LPCWSTR optional
        boolean fIgnoreHKCU,   // BOOL
        boolean fDefault   // BOOL
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegGetBoolUSValueW = SHRegGetBoolUSValueW(
    pszSubKey : UInt16*,   # LPCWSTR
    pszValue : UInt16*,   # LPCWSTR optional
    fIgnoreHKCU : Int32,   # BOOL
    fDefault : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHRegGetBoolUSValueWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Int32, Int32);
typedef SHRegGetBoolUSValueWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, int);
final SHRegGetBoolUSValueW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegGetBoolUSValueWNative, SHRegGetBoolUSValueWDart>('SHRegGetBoolUSValueW');
// pszSubKey : LPCWSTR -> Pointer<Utf16>
// pszValue : LPCWSTR optional -> Pointer<Utf16>
// fIgnoreHKCU : BOOL -> Int32
// fDefault : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHRegGetBoolUSValueW(
  pszSubKey: PWideChar;   // LPCWSTR
  pszValue: PWideChar;   // LPCWSTR optional
  fIgnoreHKCU: BOOL;   // BOOL
  fDefault: BOOL   // BOOL
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'SHRegGetBoolUSValueW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHRegGetBoolUSValueW"
  c_SHRegGetBoolUSValueW :: CWString -> CWString -> CInt -> CInt -> IO CInt
-- pszSubKey : LPCWSTR -> CWString
-- pszValue : LPCWSTR optional -> CWString
-- fIgnoreHKCU : BOOL -> CInt
-- fDefault : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shreggetboolusvaluew =
  foreign "SHRegGetBoolUSValueW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> int32_t @-> returning int32_t)
(* pszSubKey : LPCWSTR -> (ptr uint16_t) *)
(* pszValue : LPCWSTR optional -> (ptr uint16_t) *)
(* fIgnoreHKCU : BOOL -> int32_t *)
(* fDefault : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHRegGetBoolUSValueW" shreg-get-bool-usvalue-w :convention :stdcall) :int32
  (psz-sub-key (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-value (:string :encoding :utf-16le))   ; LPCWSTR optional
  (f-ignore-hkcu :int32)   ; BOOL
  (f-default :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHRegGetBoolUSValueW = Win32::API::More->new('SHLWAPI',
    'BOOL SHRegGetBoolUSValueW(LPCWSTR pszSubKey, LPCWSTR pszValue, BOOL fIgnoreHKCU, BOOL fDefault)');
# my $ret = $SHRegGetBoolUSValueW->Call($pszSubKey, $pszValue, $fIgnoreHKCU, $fDefault);
# pszSubKey : LPCWSTR -> LPCWSTR
# pszValue : LPCWSTR optional -> LPCWSTR
# fIgnoreHKCU : BOOL -> BOOL
# fDefault : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い