SHOpenRegStream2A
関数レジストリ値の内容を扱うストリームを開く拡張版である。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
IStream* SHOpenRegStream2A(
HKEY hkey,
LPCSTR pszSubkey, // optional
LPCSTR pszValue, // optional
DWORD grfMode
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hkey | HKEY | in | 必須。値を含むサブツリー(HKEY_LOCAL_MACHINE など)。 |
| pszSubkey | LPCSTR | inoptional | 省略可能。値を含むサブキーを指定する、null で終わる文字列へのポインター。この値は NULL でもかまいません。 |
| pszValue | LPCSTR | inoptional | アクセスする値を指定する、null で終わる文字列へのポインター。この値は NULL でもかまいません。 |
| grfMode | DWORD | in | ストリームに対するアクセスの種類。次のいずれかの値を指定できます。 STGM_READ読み取り用にストリームを開きます。 STGM_WRITE書き込み用にストリームを開きます。 STGM_READWRITE読み取りおよび書き込み用にストリームを開きます。 |
戻り値の型: IStream*
公式ドキュメント
レジストリ値を開き、その値の読み取りまたは書き込みに使用できるストリームを提供します。この関数は SHOpenRegStream に代わるものです。(ANSI)
戻り値
型: IStream*
成功した場合は IStream インターフェイスポインターを返します。それ以外の場合は NULL を返します。NULL 値は、無効な hkey または pszSubkey、pszSubkey で指定されたサブキーが存在しない、呼び出し元がサブキーにアクセスするための十分なアクセス許可を持っていない、ストリームを開けないなど、いくつかの状況によって発生する可能性があります。
解説(Remarks)
返されたオブジェクトの IStream オブジェクトが不要になったときに、その Release メソッドを呼び出す責任は、呼び出し元のアプリケーションにあります。
メモ
shlwapi.h ヘッダーは、SHOpenRegStream2 を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存ではないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、関数プロトタイプの規則を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
IStream* SHOpenRegStream2A(
HKEY hkey,
LPCSTR pszSubkey, // optional
LPCSTR pszValue, // optional
DWORD grfMode
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr SHOpenRegStream2A(
IntPtr hkey, // HKEY
[MarshalAs(UnmanagedType.LPStr)] string pszSubkey, // LPCSTR optional
[MarshalAs(UnmanagedType.LPStr)] string pszValue, // LPCSTR optional
uint grfMode // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHOpenRegStream2A(
hkey As IntPtr, ' HKEY
<MarshalAs(UnmanagedType.LPStr)> pszSubkey As String, ' LPCSTR optional
<MarshalAs(UnmanagedType.LPStr)> pszValue As String, ' LPCSTR optional
grfMode As UInteger ' DWORD
) As IntPtr
End Function' hkey : HKEY
' pszSubkey : LPCSTR optional
' pszValue : LPCSTR optional
' grfMode : DWORD
Declare PtrSafe Function SHOpenRegStream2A Lib "shlwapi" ( _
ByVal hkey As LongPtr, _
ByVal pszSubkey As String, _
ByVal pszValue As String, _
ByVal grfMode As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SHOpenRegStream2A = ctypes.windll.shlwapi.SHOpenRegStream2A
SHOpenRegStream2A.restype = ctypes.c_void_p
SHOpenRegStream2A.argtypes = [
wintypes.HANDLE, # hkey : HKEY
wintypes.LPCSTR, # pszSubkey : LPCSTR optional
wintypes.LPCSTR, # pszValue : LPCSTR optional
wintypes.DWORD, # grfMode : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
SHOpenRegStream2A = Fiddle::Function.new(
lib['SHOpenRegStream2A'],
[
Fiddle::TYPE_VOIDP, # hkey : HKEY
Fiddle::TYPE_VOIDP, # pszSubkey : LPCSTR optional
Fiddle::TYPE_VOIDP, # pszValue : LPCSTR optional
-Fiddle::TYPE_INT, # grfMode : DWORD
],
Fiddle::TYPE_VOIDP)#[link(name = "shlwapi")]
extern "system" {
fn SHOpenRegStream2A(
hkey: *mut core::ffi::c_void, // HKEY
pszSubkey: *const u8, // LPCSTR optional
pszValue: *const u8, // LPCSTR 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.Ansi)]
public static extern IntPtr SHOpenRegStream2A(IntPtr hkey, [MarshalAs(UnmanagedType.LPStr)] string pszSubkey, [MarshalAs(UnmanagedType.LPStr)] string pszValue, uint grfMode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHOpenRegStream2A' -Namespace Win32 -PassThru
# $api::SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode)#uselib "SHLWAPI.dll"
#func global SHOpenRegStream2A "SHOpenRegStream2A" sptr, sptr, sptr, sptr
; SHOpenRegStream2A hkey, pszSubkey, pszValue, grfMode ; 戻り値は stat
; hkey : HKEY -> "sptr"
; pszSubkey : LPCSTR optional -> "sptr"
; pszValue : LPCSTR optional -> "sptr"
; grfMode : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global SHOpenRegStream2A "SHOpenRegStream2A" sptr, str, str, int
; res = SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode)
; hkey : HKEY -> "sptr"
; pszSubkey : LPCSTR optional -> "str"
; pszValue : LPCSTR optional -> "str"
; grfMode : DWORD -> "int"; IStream* SHOpenRegStream2A(HKEY hkey, LPCSTR pszSubkey, LPCSTR pszValue, DWORD grfMode)
#uselib "SHLWAPI.dll"
#cfunc global SHOpenRegStream2A "SHOpenRegStream2A" intptr, str, str, int
; res = SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode)
; hkey : HKEY -> "intptr"
; pszSubkey : LPCSTR optional -> "str"
; pszValue : LPCSTR optional -> "str"
; grfMode : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHOpenRegStream2A = shlwapi.NewProc("SHOpenRegStream2A")
)
// hkey (HKEY), pszSubkey (LPCSTR optional), pszValue (LPCSTR optional), grfMode (DWORD)
r1, _, err := procSHOpenRegStream2A.Call(
uintptr(hkey),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSubkey))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszValue))),
uintptr(grfMode),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // IStream*function SHOpenRegStream2A(
hkey: THandle; // HKEY
pszSubkey: PAnsiChar; // LPCSTR optional
pszValue: PAnsiChar; // LPCSTR optional
grfMode: DWORD // DWORD
): Pointer; stdcall;
external 'SHLWAPI.dll' name 'SHOpenRegStream2A';result := DllCall("SHLWAPI\SHOpenRegStream2A"
, "Ptr", hkey ; HKEY
, "AStr", pszSubkey ; LPCSTR optional
, "AStr", pszValue ; LPCSTR optional
, "UInt", grfMode ; DWORD
, "Ptr") ; return: IStream*●SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode) = DLL("SHLWAPI.dll", "void* SHOpenRegStream2A(void*, char*, char*, dword)")
# 呼び出し: SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode)
# hkey : HKEY -> "void*"
# pszSubkey : LPCSTR optional -> "char*"
# pszValue : LPCSTR optional -> "char*"
# grfMode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn SHOpenRegStream2A(
hkey: ?*anyopaque, // HKEY
pszSubkey: [*c]const u8, // LPCSTR optional
pszValue: [*c]const u8, // LPCSTR optional
grfMode: u32 // DWORD
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc SHOpenRegStream2A(
hkey: pointer, # HKEY
pszSubkey: cstring, # LPCSTR optional
pszValue: cstring, # LPCSTR optional
grfMode: uint32 # DWORD
): pointer {.importc: "SHOpenRegStream2A", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
void* SHOpenRegStream2A(
void* hkey, // HKEY
const(char)* pszSubkey, // LPCSTR optional
const(char)* pszValue, // LPCSTR optional
uint grfMode // DWORD
);ccall((:SHOpenRegStream2A, "SHLWAPI.dll"), stdcall, Ptr{Cvoid},
(Ptr{Cvoid}, Cstring, Cstring, UInt32),
hkey, pszSubkey, pszValue, grfMode)
# hkey : HKEY -> Ptr{Cvoid}
# pszSubkey : LPCSTR optional -> Cstring
# pszValue : LPCSTR optional -> Cstring
# grfMode : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* SHOpenRegStream2A(
void* hkey,
const char* pszSubkey,
const char* pszValue,
uint32_t grfMode);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode)
-- hkey : HKEY
-- pszSubkey : LPCSTR optional
-- pszValue : LPCSTR optional
-- grfMode : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHOpenRegStream2A = lib.func('__stdcall', 'SHOpenRegStream2A', 'void *', ['void *', 'str', 'str', 'uint32_t']);
// SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode)
// hkey : HKEY -> 'void *'
// pszSubkey : LPCSTR optional -> 'str'
// pszValue : LPCSTR optional -> 'str'
// grfMode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
SHOpenRegStream2A: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "pointer" },
});
// lib.symbols.SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode)
// hkey : HKEY -> "pointer"
// pszSubkey : LPCSTR optional -> "buffer"
// pszValue : LPCSTR optional -> "buffer"
// grfMode : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* SHOpenRegStream2A(
void* hkey,
const char* pszSubkey,
const char* pszValue,
uint32_t grfMode);
C, "SHLWAPI.dll");
// $ffi->SHOpenRegStream2A(hkey, pszSubkey, pszValue, grfMode);
// hkey : HKEY
// pszSubkey : LPCSTR optional
// pszValue : LPCSTR 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.ASCII_OPTIONS);
Pointer SHOpenRegStream2A(
Pointer hkey, // HKEY
String pszSubkey, // LPCSTR optional
String pszValue, // LPCSTR optional
int grfMode // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun SHOpenRegStream2A = SHOpenRegStream2A(
hkey : Void*, # HKEY
pszSubkey : UInt8*, # LPCSTR optional
pszValue : UInt8*, # LPCSTR 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 SHOpenRegStream2ANative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef SHOpenRegStream2ADart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, int);
final SHOpenRegStream2A = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHOpenRegStream2ANative, SHOpenRegStream2ADart>('SHOpenRegStream2A');
// hkey : HKEY -> Pointer<Void>
// pszSubkey : LPCSTR optional -> Pointer<Utf8>
// pszValue : LPCSTR optional -> Pointer<Utf8>
// grfMode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHOpenRegStream2A(
hkey: THandle; // HKEY
pszSubkey: PAnsiChar; // LPCSTR optional
pszValue: PAnsiChar; // LPCSTR optional
grfMode: DWORD // DWORD
): Pointer; stdcall;
external 'SHLWAPI.dll' name 'SHOpenRegStream2A';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHOpenRegStream2A"
c_SHOpenRegStream2A :: Ptr () -> CString -> CString -> Word32 -> IO (Ptr ())
-- hkey : HKEY -> Ptr ()
-- pszSubkey : LPCSTR optional -> CString
-- pszValue : LPCSTR optional -> CString
-- grfMode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shopenregstream2a =
foreign "SHOpenRegStream2A"
((ptr void) @-> string @-> string @-> uint32_t @-> returning (ptr void))
(* hkey : HKEY -> (ptr void) *)
(* pszSubkey : LPCSTR optional -> string *)
(* pszValue : LPCSTR optional -> string *)
(* 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 ("SHOpenRegStream2A" shopen-reg-stream2-a :convention :stdcall) :pointer
(hkey :pointer) ; HKEY
(psz-subkey :string) ; LPCSTR optional
(psz-value :string) ; LPCSTR optional
(grf-mode :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHOpenRegStream2A = Win32::API::More->new('SHLWAPI',
'LPVOID SHOpenRegStream2A(HANDLE hkey, LPCSTR pszSubkey, LPCSTR pszValue, DWORD grfMode)');
# my $ret = $SHOpenRegStream2A->Call($hkey, $pszSubkey, $pszValue, $grfMode);
# hkey : HKEY -> HANDLE
# pszSubkey : LPCSTR optional -> LPCSTR
# pszValue : LPCSTR optional -> LPCSTR
# grfMode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f SHOpenRegStream2W (Unicode版) — レジストリ値の内容を扱うストリームを開く拡張版である。
類似 API
- f SHOpenRegStreamA — レジストリ値の内容を読み書きするストリームを開く。
使用する型