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

SHOpenRegStream2W

関数
レジストリ値の内容を扱うストリームを開く拡張版である。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

IStream* SHOpenRegStream2W(
    HKEY hkey,
    LPCWSTR pszSubkey,   // optional
    LPCWSTR pszValue,   // optional
    DWORD grfMode
);

パラメーター

名前方向説明
hkeyHKEYin必須。値を含むサブツリー(HKEY_LOCAL_MACHINE など)を指定します。
pszSubkeyLPCWSTRinoptional省略可能。値を含むサブキーを指定する null 終端文字列へのポインターです。この値は NULL にすることができます。
pszValueLPCWSTRinoptionalアクセスする値を指定する null 終端文字列へのポインターです。この値は NULL にすることができます。
grfModeDWORDin

ストリームへのアクセスの種類です。次のいずれかの値を指定できます。

STGM_READ

読み取り用にストリームを開きます。

STGM_WRITE

書き込み用にストリームを開きます。

STGM_READWRITE

読み取りおよび書き込み用にストリームを開きます。

- grfMode.STGM_READ

読み取り用にストリームを開きます。

- grfMode.STGM_READWRITE

読み取りおよび書き込み用にストリームを開きます。

- grfMode.STGM_WRITE

書き込み用にストリームを開きます。

戻り値の型: IStream*

公式ドキュメント

レジストリ値を開き、その値の読み取りまたは書き込みに使用できるストリームを提供します。この関数は SHOpenRegStream に代わるものです。(Unicode)

戻り値

Type: IStream*

成功した場合は IStream インターフェイスへのポインターを返します。それ以外の場合は NULL を返します。NULL 値は、無効な hkey または pszSubkeypszSubkey で指定されたサブキーが存在しない、サブキーにアクセスするための十分な権限を呼び出し元が持っていない、ストリームを開けないなど、いくつかの状況によって発生する可能性があります。

解説(Remarks)

返されたオブジェクトを呼び出し元のアプリケーションは、その IStream オブジェクトが不要になった時点で、Release メソッドを呼び出す責任があります。

メモ

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

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

IStream* SHOpenRegStream2W(
    HKEY hkey,
    LPCWSTR pszSubkey,   // optional
    LPCWSTR pszValue,   // optional
    DWORD grfMode
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr SHOpenRegStream2W(
    IntPtr hkey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string pszSubkey,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszValue,   // LPCWSTR optional
    uint grfMode   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHOpenRegStream2W(
    hkey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> pszSubkey As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pszValue As String,   ' LPCWSTR optional
    grfMode As UInteger   ' DWORD
) As IntPtr
End Function
' hkey : HKEY
' pszSubkey : LPCWSTR optional
' pszValue : LPCWSTR optional
' grfMode : DWORD
Declare PtrSafe Function SHOpenRegStream2W Lib "shlwapi" ( _
    ByVal hkey As LongPtr, _
    ByVal pszSubkey As LongPtr, _
    ByVal pszValue As LongPtr, _
    ByVal grfMode As Long) As LongPtr
' 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

SHOpenRegStream2W = ctypes.windll.shlwapi.SHOpenRegStream2W
SHOpenRegStream2W.restype = ctypes.c_void_p
SHOpenRegStream2W.argtypes = [
    wintypes.HANDLE,  # hkey : HKEY
    wintypes.LPCWSTR,  # pszSubkey : LPCWSTR optional
    wintypes.LPCWSTR,  # pszValue : LPCWSTR optional
    wintypes.DWORD,  # grfMode : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHOpenRegStream2W = shlwapi.NewProc("SHOpenRegStream2W")
)

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

extern "shlwapi" fn SHOpenRegStream2W(
    hkey: ?*anyopaque, // HKEY
    pszSubkey: [*c]const u16, // LPCWSTR optional
    pszValue: [*c]const u16, // LPCWSTR optional
    grfMode: u32 // DWORD
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHOpenRegStream2W(
    hkey: pointer,  # HKEY
    pszSubkey: WideCString,  # LPCWSTR optional
    pszValue: WideCString,  # LPCWSTR optional
    grfMode: uint32  # DWORD
): pointer {.importc: "SHOpenRegStream2W", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
void* SHOpenRegStream2W(
    void* hkey,   // HKEY
    const(wchar)* pszSubkey,   // LPCWSTR optional
    const(wchar)* pszValue,   // LPCWSTR optional
    uint grfMode   // DWORD
);
ccall((:SHOpenRegStream2W, "SHLWAPI.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cwstring, Cwstring, UInt32),
      hkey, pszSubkey, pszValue, grfMode)
# hkey : HKEY -> Ptr{Cvoid}
# pszSubkey : LPCWSTR optional -> Cwstring
# pszValue : LPCWSTR optional -> Cwstring
# grfMode : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* SHOpenRegStream2W(
    void* hkey,
    const uint16_t* pszSubkey,
    const uint16_t* pszValue,
    uint32_t grfMode);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHOpenRegStream2W(hkey, pszSubkey, pszValue, grfMode)
-- hkey : HKEY
-- pszSubkey : LPCWSTR optional
-- pszValue : LPCWSTR optional
-- grfMode : DWORD
-- 構造体/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 SHOpenRegStream2W = lib.func('__stdcall', 'SHOpenRegStream2W', 'void *', ['void *', 'str16', 'str16', 'uint32_t']);
// SHOpenRegStream2W(hkey, pszSubkey, pszValue, grfMode)
// hkey : HKEY -> 'void *'
// pszSubkey : LPCWSTR optional -> 'str16'
// pszValue : LPCWSTR optional -> 'str16'
// grfMode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHOpenRegStream2W: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "pointer" },
});
// lib.symbols.SHOpenRegStream2W(hkey, pszSubkey, pszValue, grfMode)
// hkey : HKEY -> "pointer"
// pszSubkey : LPCWSTR optional -> "buffer"
// pszValue : LPCWSTR optional -> "buffer"
// grfMode : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* SHOpenRegStream2W(
    void* hkey,
    const uint16_t* pszSubkey,
    const uint16_t* pszValue,
    uint32_t grfMode);
C, "SHLWAPI.dll");
// $ffi->SHOpenRegStream2W(hkey, pszSubkey, pszValue, grfMode);
// hkey : HKEY
// pszSubkey : LPCWSTR optional
// pszValue : LPCWSTR optional
// grfMode : DWORD
// 構造体/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);
    Pointer SHOpenRegStream2W(
        Pointer hkey,   // HKEY
        WString pszSubkey,   // LPCWSTR optional
        WString pszValue,   // LPCWSTR optional
        int grfMode   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHOpenRegStream2W = SHOpenRegStream2W(
    hkey : Void*,   # HKEY
    pszSubkey : UInt16*,   # LPCWSTR optional
    pszValue : UInt16*,   # LPCWSTR optional
    grfMode : UInt32   # DWORD
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHOpenRegStream2WNative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef SHOpenRegStream2WDart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int);
final SHOpenRegStream2W = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHOpenRegStream2WNative, SHOpenRegStream2WDart>('SHOpenRegStream2W');
// hkey : HKEY -> Pointer<Void>
// pszSubkey : LPCWSTR optional -> Pointer<Utf16>
// pszValue : LPCWSTR optional -> Pointer<Utf16>
// grfMode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHOpenRegStream2W(
  hkey: THandle;   // HKEY
  pszSubkey: PWideChar;   // LPCWSTR optional
  pszValue: PWideChar;   // LPCWSTR optional
  grfMode: DWORD   // DWORD
): Pointer; stdcall;
  external 'SHLWAPI.dll' name 'SHOpenRegStream2W';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHOpenRegStream2W"
  c_SHOpenRegStream2W :: Ptr () -> CWString -> CWString -> Word32 -> IO (Ptr ())
-- hkey : HKEY -> Ptr ()
-- pszSubkey : LPCWSTR optional -> CWString
-- pszValue : LPCWSTR optional -> CWString
-- grfMode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shopenregstream2w =
  foreign "SHOpenRegStream2W"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning (ptr void))
(* hkey : HKEY -> (ptr void) *)
(* pszSubkey : LPCWSTR optional -> (ptr uint16_t) *)
(* pszValue : LPCWSTR optional -> (ptr uint16_t) *)
(* grfMode : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHOpenRegStream2W" shopen-reg-stream2-w :convention :stdcall) :pointer
  (hkey :pointer)   ; HKEY
  (psz-subkey (:string :encoding :utf-16le))   ; LPCWSTR optional
  (psz-value (:string :encoding :utf-16le))   ; LPCWSTR optional
  (grf-mode :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHOpenRegStream2W = Win32::API::More->new('SHLWAPI',
    'LPVOID SHOpenRegStream2W(HANDLE hkey, LPCWSTR pszSubkey, LPCWSTR pszValue, DWORD grfMode)');
# my $ret = $SHOpenRegStream2W->Call($hkey, $pszSubkey, $pszValue, $grfMode);
# hkey : HKEY -> HANDLE
# pszSubkey : LPCWSTR optional -> LPCWSTR
# pszValue : LPCWSTR optional -> LPCWSTR
# grfMode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
使用する型