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

SHRegGetIntW

関数
レジストリ値を整数として取得し既定値で補う。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll
#include <windows.h>

INT SHRegGetIntW(
    HKEY hk,
    LPCWSTR pwzKey,   // optional
    INT iDefault
);

パラメーター

名前方向説明
hkHKEYin読み取る値を含むレジストリキーへのハンドルです。
pwzKeyLPCWSTRinoptional読み取る値の名前を指定する文字列値へのポインターです。文字列は null で終端されている必要があります。
iDefaultINTinレジストリ値を正常に取得できなかった場合に返される値を指定する int です。

戻り値の型: INT

公式ドキュメント

レジストリから数値文字列の値を読み取り、整数に変換します。

戻り値

型: int

変換された文字列を int として返します。取得できなかった場合は nDefault で指定された既定値を返します。

解説(Remarks)

Windows 2000 Service Pack 3 (SP3)、Windows Server 2003 Service Pack 1 (SP1)、および Windows XP より前のバージョンでは、SHRegGetIntW は名前でエクスポートされていませんでした。これらのシステムでは、Shlwapi.dll から序数 280 として直接ロードする必要があります。

この関数は Unicode バージョンでのみ使用できます。ANSI はサポートされていません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHLWAPI.dll
#include <windows.h>

INT SHRegGetIntW(
    HKEY hk,
    LPCWSTR pwzKey,   // optional
    INT iDefault
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int SHRegGetIntW(
    IntPtr hk,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string pwzKey,   // LPCWSTR optional
    int iDefault   // INT
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHRegGetIntW(
    hk As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> pwzKey As String,   ' LPCWSTR optional
    iDefault As Integer   ' INT
) As Integer
End Function
' hk : HKEY
' pwzKey : LPCWSTR optional
' iDefault : INT
Declare PtrSafe Function SHRegGetIntW Lib "shlwapi" ( _
    ByVal hk As LongPtr, _
    ByVal pwzKey As LongPtr, _
    ByVal iDefault As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHRegGetIntW = ctypes.windll.shlwapi.SHRegGetIntW
SHRegGetIntW.restype = ctypes.c_int
SHRegGetIntW.argtypes = [
    wintypes.HANDLE,  # hk : HKEY
    wintypes.LPCWSTR,  # pwzKey : LPCWSTR optional
    ctypes.c_int,  # iDefault : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHRegGetIntW = Fiddle::Function.new(
  lib['SHRegGetIntW'],
  [
    Fiddle::TYPE_VOIDP,  # hk : HKEY
    Fiddle::TYPE_VOIDP,  # pwzKey : LPCWSTR optional
    Fiddle::TYPE_INT,  # iDefault : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHRegGetIntW(
        hk: *mut core::ffi::c_void,  // HKEY
        pwzKey: *const u16,  // LPCWSTR optional
        iDefault: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int SHRegGetIntW(IntPtr hk, [MarshalAs(UnmanagedType.LPWStr)] string pwzKey, int iDefault);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHRegGetIntW' -Namespace Win32 -PassThru
# $api::SHRegGetIntW(hk, pwzKey, iDefault)
#uselib "SHLWAPI.dll"
#func global SHRegGetIntW "SHRegGetIntW" sptr, sptr, sptr
; SHRegGetIntW hk, pwzKey, iDefault   ; 戻り値は stat
; hk : HKEY -> "sptr"
; pwzKey : LPCWSTR optional -> "sptr"
; iDefault : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetIntW "SHRegGetIntW" sptr, wstr, int
; res = SHRegGetIntW(hk, pwzKey, iDefault)
; hk : HKEY -> "sptr"
; pwzKey : LPCWSTR optional -> "wstr"
; iDefault : INT -> "int"
; INT SHRegGetIntW(HKEY hk, LPCWSTR pwzKey, INT iDefault)
#uselib "SHLWAPI.dll"
#cfunc global SHRegGetIntW "SHRegGetIntW" intptr, wstr, int
; res = SHRegGetIntW(hk, pwzKey, iDefault)
; hk : HKEY -> "intptr"
; pwzKey : LPCWSTR optional -> "wstr"
; iDefault : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHRegGetIntW = shlwapi.NewProc("SHRegGetIntW")
)

// hk (HKEY), pwzKey (LPCWSTR optional), iDefault (INT)
r1, _, err := procSHRegGetIntW.Call(
	uintptr(hk),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwzKey))),
	uintptr(iDefault),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SHRegGetIntW(
  hk: THandle;   // HKEY
  pwzKey: PWideChar;   // LPCWSTR optional
  iDefault: Integer   // INT
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHRegGetIntW';
result := DllCall("SHLWAPI\SHRegGetIntW"
    , "Ptr", hk   ; HKEY
    , "WStr", pwzKey   ; LPCWSTR optional
    , "Int", iDefault   ; INT
    , "Int")   ; return: INT
●SHRegGetIntW(hk, pwzKey, iDefault) = DLL("SHLWAPI.dll", "int SHRegGetIntW(void*, char*, int)")
# 呼び出し: SHRegGetIntW(hk, pwzKey, iDefault)
# hk : HKEY -> "void*"
# pwzKey : LPCWSTR optional -> "char*"
# iDefault : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn SHRegGetIntW(
    hk: ?*anyopaque, // HKEY
    pwzKey: [*c]const u16, // LPCWSTR optional
    iDefault: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc SHRegGetIntW(
    hk: pointer,  # HKEY
    pwzKey: WideCString,  # LPCWSTR optional
    iDefault: int32  # INT
): int32 {.importc: "SHRegGetIntW", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int SHRegGetIntW(
    void* hk,   // HKEY
    const(wchar)* pwzKey,   // LPCWSTR optional
    int iDefault   // INT
);
ccall((:SHRegGetIntW, "SHLWAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Int32),
      hk, pwzKey, iDefault)
# hk : HKEY -> Ptr{Cvoid}
# pwzKey : LPCWSTR optional -> Cwstring
# iDefault : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHRegGetIntW(
    void* hk,
    const uint16_t* pwzKey,
    int32_t iDefault);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHRegGetIntW(hk, pwzKey, iDefault)
-- hk : HKEY
-- pwzKey : LPCWSTR optional
-- iDefault : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHRegGetIntW = lib.func('__stdcall', 'SHRegGetIntW', 'int32_t', ['void *', 'str16', 'int32_t']);
// SHRegGetIntW(hk, pwzKey, iDefault)
// hk : HKEY -> 'void *'
// pwzKey : LPCWSTR optional -> 'str16'
// iDefault : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHRegGetIntW: { parameters: ["pointer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.SHRegGetIntW(hk, pwzKey, iDefault)
// hk : HKEY -> "pointer"
// pwzKey : LPCWSTR optional -> "buffer"
// iDefault : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHRegGetIntW(
    void* hk,
    const uint16_t* pwzKey,
    int32_t iDefault);
C, "SHLWAPI.dll");
// $ffi->SHRegGetIntW(hk, pwzKey, iDefault);
// hk : HKEY
// pwzKey : LPCWSTR optional
// iDefault : INT
// 構造体/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);
    int SHRegGetIntW(
        Pointer hk,   // HKEY
        WString pwzKey,   // LPCWSTR optional
        int iDefault   // INT
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHRegGetIntW = SHRegGetIntW(
    hk : Void*,   # HKEY
    pwzKey : UInt16*,   # LPCWSTR optional
    iDefault : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHRegGetIntWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Int32);
typedef SHRegGetIntWDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final SHRegGetIntW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHRegGetIntWNative, SHRegGetIntWDart>('SHRegGetIntW');
// hk : HKEY -> Pointer<Void>
// pwzKey : LPCWSTR optional -> Pointer<Utf16>
// iDefault : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHRegGetIntW(
  hk: THandle;   // HKEY
  pwzKey: PWideChar;   // LPCWSTR optional
  iDefault: Integer   // INT
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHRegGetIntW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHRegGetIntW"
  c_SHRegGetIntW :: Ptr () -> CWString -> Int32 -> IO Int32
-- hk : HKEY -> Ptr ()
-- pwzKey : LPCWSTR optional -> CWString
-- iDefault : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shreggetintw =
  foreign "SHRegGetIntW"
    ((ptr void) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* hk : HKEY -> (ptr void) *)
(* pwzKey : LPCWSTR optional -> (ptr uint16_t) *)
(* iDefault : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHRegGetIntW" shreg-get-int-w :convention :stdcall) :int32
  (hk :pointer)   ; HKEY
  (pwz-key (:string :encoding :utf-16le))   ; LPCWSTR optional
  (i-default :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHRegGetIntW = Win32::API::More->new('SHLWAPI',
    'int SHRegGetIntW(HANDLE hk, LPCWSTR pwzKey, int iDefault)');
# my $ret = $SHRegGetIntW->Call($hk, $pwzKey, $iDefault);
# hk : HKEY -> HANDLE
# pwzKey : LPCWSTR optional -> LPCWSTR
# iDefault : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。