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

SHRegGetBoolUSValueA

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

シグネチャ

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

BOOL SHRegGetBoolUSValueA(
    LPCSTR pszSubKey,
    LPCSTR pszValue,   // optional
    BOOL fIgnoreHKCU,
    BOOL fDefault
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

解説(Remarks)

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHRegGetBoolUSValue を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じてコンパイル エラーまたは実行時エラーの原因となる可能性があります。詳細については、「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>

BOOL SHRegGetBoolUSValueA(
    LPCSTR pszSubKey,
    LPCSTR pszValue,   // optional
    BOOL fIgnoreHKCU,
    BOOL fDefault
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SHRegGetBoolUSValueA(
    [MarshalAs(UnmanagedType.LPStr)] string pszSubKey,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszValue,   // LPCSTR optional
    bool fIgnoreHKCU,   // BOOL
    bool fDefault   // BOOL
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHRegGetBoolUSValueA(
    <MarshalAs(UnmanagedType.LPStr)> pszSubKey As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszValue As String,   ' LPCSTR optional
    fIgnoreHKCU As Boolean,   ' BOOL
    fDefault As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszSubKey : LPCSTR
' pszValue : LPCSTR optional
' fIgnoreHKCU : BOOL
' fDefault : BOOL
Declare PtrSafe Function SHRegGetBoolUSValueA Lib "shlwapi" ( _
    ByVal pszSubKey As String, _
    ByVal pszValue As String, _
    ByVal fIgnoreHKCU As Long, _
    ByVal fDefault As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegGetBoolUSValueA = Fiddle::Function.new(
  lib['SHRegGetBoolUSValueA'],
  [
    Fiddle::TYPE_VOIDP,  # pszSubKey : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszValue : LPCSTR optional
    Fiddle::TYPE_INT,  # fIgnoreHKCU : BOOL
    Fiddle::TYPE_INT,  # fDefault : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHRegGetBoolUSValueA(
        pszSubKey: *const u8,  // LPCSTR
        pszValue: *const u8,  // LPCSTR 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.Ansi)]
public static extern bool SHRegGetBoolUSValueA([MarshalAs(UnmanagedType.LPStr)] string pszSubKey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, bool fIgnoreHKCU, bool fDefault);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegGetBoolUSValueA' -Namespace Win32 -PassThru
# $api::SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
#uselib "SHLWAPI.dll"
#func global SHRegGetBoolUSValueA "SHRegGetBoolUSValueA" sptr, sptr, sptr, sptr
; SHRegGetBoolUSValueA pszSubKey, pszValue, fIgnoreHKCU, fDefault   ; 戻り値は stat
; pszSubKey : LPCSTR -> "sptr"
; pszValue : LPCSTR optional -> "sptr"
; fIgnoreHKCU : BOOL -> "sptr"
; fDefault : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetBoolUSValueA "SHRegGetBoolUSValueA" str, str, int, int
; res = SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
; pszSubKey : LPCSTR -> "str"
; pszValue : LPCSTR optional -> "str"
; fIgnoreHKCU : BOOL -> "int"
; fDefault : BOOL -> "int"
; BOOL SHRegGetBoolUSValueA(LPCSTR pszSubKey, LPCSTR pszValue, BOOL fIgnoreHKCU, BOOL fDefault)
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetBoolUSValueA "SHRegGetBoolUSValueA" str, str, int, int
; res = SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
; pszSubKey : LPCSTR -> "str"
; pszValue : LPCSTR optional -> "str"
; fIgnoreHKCU : BOOL -> "int"
; fDefault : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHRegGetBoolUSValueA = shlwapi.NewProc("SHRegGetBoolUSValueA")
)

// pszSubKey (LPCSTR), pszValue (LPCSTR optional), fIgnoreHKCU (BOOL), fDefault (BOOL)
r1, _, err := procSHRegGetBoolUSValueA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSubKey))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszValue))),
	uintptr(fIgnoreHKCU),
	uintptr(fDefault),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHRegGetBoolUSValueA(
  pszSubKey: PAnsiChar;   // LPCSTR
  pszValue: PAnsiChar;   // LPCSTR optional
  fIgnoreHKCU: BOOL;   // BOOL
  fDefault: BOOL   // BOOL
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'SHRegGetBoolUSValueA';
result := DllCall("SHLWAPI\SHRegGetBoolUSValueA"
    , "AStr", pszSubKey   ; LPCSTR
    , "AStr", pszValue   ; LPCSTR optional
    , "Int", fIgnoreHKCU   ; BOOL
    , "Int", fDefault   ; BOOL
    , "Int")   ; return: BOOL
●SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault) = DLL("SHLWAPI.dll", "bool SHRegGetBoolUSValueA(char*, char*, bool, bool)")
# 呼び出し: SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
# pszSubKey : LPCSTR -> "char*"
# pszValue : LPCSTR optional -> "char*"
# fIgnoreHKCU : BOOL -> "bool"
# fDefault : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn SHRegGetBoolUSValueA(
    pszSubKey: [*c]const u8, // LPCSTR
    pszValue: [*c]const u8, // LPCSTR optional
    fIgnoreHKCU: i32, // BOOL
    fDefault: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc SHRegGetBoolUSValueA(
    pszSubKey: cstring,  # LPCSTR
    pszValue: cstring,  # LPCSTR optional
    fIgnoreHKCU: int32,  # BOOL
    fDefault: int32  # BOOL
): int32 {.importc: "SHRegGetBoolUSValueA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int SHRegGetBoolUSValueA(
    const(char)* pszSubKey,   // LPCSTR
    const(char)* pszValue,   // LPCSTR optional
    int fIgnoreHKCU,   // BOOL
    int fDefault   // BOOL
);
ccall((:SHRegGetBoolUSValueA, "SHLWAPI.dll"), stdcall, Int32,
      (Cstring, Cstring, Int32, Int32),
      pszSubKey, pszValue, fIgnoreHKCU, fDefault)
# pszSubKey : LPCSTR -> Cstring
# pszValue : LPCSTR optional -> Cstring
# fIgnoreHKCU : BOOL -> Int32
# fDefault : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHRegGetBoolUSValueA(
    const char* pszSubKey,
    const char* pszValue,
    int32_t fIgnoreHKCU,
    int32_t fDefault);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
-- pszSubKey : LPCSTR
-- pszValue : LPCSTR optional
-- fIgnoreHKCU : BOOL
-- fDefault : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHRegGetBoolUSValueA = lib.func('__stdcall', 'SHRegGetBoolUSValueA', 'int32_t', ['str', 'str', 'int32_t', 'int32_t']);
// SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
// pszSubKey : LPCSTR -> 'str'
// pszValue : LPCSTR optional -> 'str'
// fIgnoreHKCU : BOOL -> 'int32_t'
// fDefault : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHRegGetBoolUSValueA: { parameters: ["buffer", "buffer", "i32", "i32"], result: "i32" },
});
// lib.symbols.SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault)
// pszSubKey : LPCSTR -> "buffer"
// pszValue : LPCSTR optional -> "buffer"
// fIgnoreHKCU : BOOL -> "i32"
// fDefault : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHRegGetBoolUSValueA(
    const char* pszSubKey,
    const char* pszValue,
    int32_t fIgnoreHKCU,
    int32_t fDefault);
C, "SHLWAPI.dll");
// $ffi->SHRegGetBoolUSValueA(pszSubKey, pszValue, fIgnoreHKCU, fDefault);
// pszSubKey : LPCSTR
// pszValue : LPCSTR 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.ASCII_OPTIONS);
    boolean SHRegGetBoolUSValueA(
        String pszSubKey,   // LPCSTR
        String pszValue,   // LPCSTR optional
        boolean fIgnoreHKCU,   // BOOL
        boolean fDefault   // BOOL
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegGetBoolUSValueA = SHRegGetBoolUSValueA(
    pszSubKey : UInt8*,   # LPCSTR
    pszValue : UInt8*,   # LPCSTR 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 SHRegGetBoolUSValueANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32, Int32);
typedef SHRegGetBoolUSValueADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, int);
final SHRegGetBoolUSValueA = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegGetBoolUSValueANative, SHRegGetBoolUSValueADart>('SHRegGetBoolUSValueA');
// pszSubKey : LPCSTR -> Pointer<Utf8>
// pszValue : LPCSTR optional -> Pointer<Utf8>
// fIgnoreHKCU : BOOL -> Int32
// fDefault : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHRegGetBoolUSValueA(
  pszSubKey: PAnsiChar;   // LPCSTR
  pszValue: PAnsiChar;   // LPCSTR optional
  fIgnoreHKCU: BOOL;   // BOOL
  fDefault: BOOL   // BOOL
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'SHRegGetBoolUSValueA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shreggetboolusvaluea =
  foreign "SHRegGetBoolUSValueA"
    (string @-> string @-> int32_t @-> int32_t @-> returning int32_t)
(* pszSubKey : LPCSTR -> string *)
(* pszValue : LPCSTR optional -> string *)
(* 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 ("SHRegGetBoolUSValueA" shreg-get-bool-usvalue-a :convention :stdcall) :int32
  (psz-sub-key :string)   ; LPCSTR
  (psz-value :string)   ; LPCSTR 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 $SHRegGetBoolUSValueA = Win32::API::More->new('SHLWAPI',
    'BOOL SHRegGetBoolUSValueA(LPCSTR pszSubKey, LPCSTR pszValue, BOOL fIgnoreHKCU, BOOL fDefault)');
# my $ret = $SHRegGetBoolUSValueA->Call($pszSubKey, $pszValue, $fIgnoreHKCU, $fDefault);
# pszSubKey : LPCSTR -> LPCSTR
# pszValue : LPCSTR optional -> LPCSTR
# fIgnoreHKCU : BOOL -> BOOL
# fDefault : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い