SHCreateMemStream
関数メモリ上のバッファを基にしたストリームを生成する。
シグネチャ
// SHLWAPI.dll
#include <windows.h>
IStream* SHCreateMemStream(
const BYTE* pInit, // optional
DWORD cbInit
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pInit | BYTE* | inoptional | サイズ cbInit のバッファへのポインターです。このバッファの内容は、メモリストリームの初期内容の設定に使用されます。このパラメーターが NULL の場合、返されるメモリストリームには初期内容がありません。 |
| cbInit | DWORD | in | pInit が指すバッファ内のバイト数です。pInit に NULL を設定した場合、cbInit はゼロでなければなりません。 |
戻り値の型: IStream*
公式ドキュメント
CreateStreamOnHGlobal と同様の処理を使用して、メモリストリームを作成します。
戻り値
型: IStream*
成功した場合、作成されたメモリストリームへのポインターを返します。ストリームオブジェクトを割り当てられなかった場合は NULL を返します。
解説(Remarks)
Windows Vista より前では、この関数は公開された Shlwapi.h ファイルに含まれておらず、Shlwapi.dll から名前でエクスポートもされていませんでした。これより古いシステムで使用するには、Shlwapi.dll ファイルから序数 12 として直接呼び出す必要があります。
この関数はメモリストリームを作成します。これは、内容をメモリに格納する IStream インターフェイスの実装です。SHCreateMemStream は、以下の点で CreateStreamOnHGlobal と異なります。
- スレッドセーフ性。SHCreateMemStream が作成するストリームは、Windows 8 以降ではスレッドセーフです。これより古いシステムでは、ストリームはスレッドセーフではありません。CreateStreamOnHGlobal が作成するストリームはスレッドセーフです。
- 初期内容。SHCreateMemStream は初期内容をバッファの形式で受け取ります。CreateStreamOnHGlobal は初期内容を HGLOBAL の形式で受け取ります。
- 内容へのアクセス。SHCreateMemStream はストリーム内容への直接アクセスを許可しません。CreateStreamOnHGlobal は GetHGlobalFromStream を通じたアクセスを許可します。
- 失敗情報。SHCreateMemStream が NULL を返した場合、必要なメモリを割り当てられなかったことを意味します。呼び出し側はその原因を E_OUTOFMEMORY と想定する必要があります。
- IStream::Clone のサポート。Windows 8 より前では、SHCreateMemStream が作成するストリームは IStream::Clone をサポートしません。CreateStreamOnHGlobal が作成するストリームはサポートします。Windows 8 以降では、SHCreateMemStream が作成するストリームは IStream::Clone をサポートします。
- SHCreateMemStream が返すストリームは、バッファの末尾を超えて読み取ろうとすると IStream::Read から S_FALSE を返します。CreateStreamOnHGlobal が返すストリームは、バッファの末尾を超えて読み取ろうとすると S_OK を返し、*pcbRead に 0 を設定します。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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
#include <windows.h>
IStream* SHCreateMemStream(
const BYTE* pInit, // optional
DWORD cbInit
);[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern IntPtr SHCreateMemStream(
IntPtr pInit, // BYTE* optional
uint cbInit // DWORD
);<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHCreateMemStream(
pInit As IntPtr, ' BYTE* optional
cbInit As UInteger ' DWORD
) As IntPtr
End Function' pInit : BYTE* optional
' cbInit : DWORD
Declare PtrSafe Function SHCreateMemStream Lib "shlwapi" ( _
ByVal pInit As LongPtr, _
ByVal cbInit As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SHCreateMemStream = ctypes.windll.shlwapi.SHCreateMemStream
SHCreateMemStream.restype = ctypes.c_void_p
SHCreateMemStream.argtypes = [
ctypes.POINTER(ctypes.c_ubyte), # pInit : BYTE* optional
wintypes.DWORD, # cbInit : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
SHCreateMemStream = Fiddle::Function.new(
lib['SHCreateMemStream'],
[
Fiddle::TYPE_VOIDP, # pInit : BYTE* optional
-Fiddle::TYPE_INT, # cbInit : DWORD
],
Fiddle::TYPE_VOIDP)#[link(name = "shlwapi")]
extern "system" {
fn SHCreateMemStream(
pInit: *const u8, // BYTE* optional
cbInit: u32 // DWORD
) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern IntPtr SHCreateMemStream(IntPtr pInit, uint cbInit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHCreateMemStream' -Namespace Win32 -PassThru
# $api::SHCreateMemStream(pInit, cbInit)#uselib "SHLWAPI.dll"
#func global SHCreateMemStream "SHCreateMemStream" sptr, sptr
; SHCreateMemStream varptr(pInit), cbInit ; 戻り値は stat
; pInit : BYTE* optional -> "sptr"
; cbInit : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global SHCreateMemStream "SHCreateMemStream" var, int ; res = SHCreateMemStream(pInit, cbInit) ; pInit : BYTE* optional -> "var" ; cbInit : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global SHCreateMemStream "SHCreateMemStream" sptr, int ; res = SHCreateMemStream(varptr(pInit), cbInit) ; pInit : BYTE* optional -> "sptr" ; cbInit : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; IStream* SHCreateMemStream(BYTE* pInit, DWORD cbInit) #uselib "SHLWAPI.dll" #cfunc global SHCreateMemStream "SHCreateMemStream" var, int ; res = SHCreateMemStream(pInit, cbInit) ; pInit : BYTE* optional -> "var" ; cbInit : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; IStream* SHCreateMemStream(BYTE* pInit, DWORD cbInit) #uselib "SHLWAPI.dll" #cfunc global SHCreateMemStream "SHCreateMemStream" intptr, int ; res = SHCreateMemStream(varptr(pInit), cbInit) ; pInit : BYTE* optional -> "intptr" ; cbInit : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procSHCreateMemStream = shlwapi.NewProc("SHCreateMemStream")
)
// pInit (BYTE* optional), cbInit (DWORD)
r1, _, err := procSHCreateMemStream.Call(
uintptr(pInit),
uintptr(cbInit),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // IStream*function SHCreateMemStream(
pInit: Pointer; // BYTE* optional
cbInit: DWORD // DWORD
): Pointer; stdcall;
external 'SHLWAPI.dll' name 'SHCreateMemStream';result := DllCall("SHLWAPI\SHCreateMemStream"
, "Ptr", pInit ; BYTE* optional
, "UInt", cbInit ; DWORD
, "Ptr") ; return: IStream*●SHCreateMemStream(pInit, cbInit) = DLL("SHLWAPI.dll", "void* SHCreateMemStream(void*, dword)")
# 呼び出し: SHCreateMemStream(pInit, cbInit)
# pInit : BYTE* optional -> "void*"
# cbInit : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn SHCreateMemStream(
pInit: [*c]u8, // BYTE* optional
cbInit: u32 // DWORD
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc SHCreateMemStream(
pInit: ptr uint8, # BYTE* optional
cbInit: uint32 # DWORD
): pointer {.importc: "SHCreateMemStream", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
void* SHCreateMemStream(
ubyte* pInit, // BYTE* optional
uint cbInit // DWORD
);ccall((:SHCreateMemStream, "SHLWAPI.dll"), stdcall, Ptr{Cvoid},
(Ptr{UInt8}, UInt32),
pInit, cbInit)
# pInit : BYTE* optional -> Ptr{UInt8}
# cbInit : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* SHCreateMemStream(
uint8_t* pInit,
uint32_t cbInit);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHCreateMemStream(pInit, cbInit)
-- pInit : BYTE* optional
-- cbInit : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHCreateMemStream = lib.func('__stdcall', 'SHCreateMemStream', 'void *', ['uint8_t *', 'uint32_t']);
// SHCreateMemStream(pInit, cbInit)
// pInit : BYTE* optional -> 'uint8_t *'
// cbInit : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
SHCreateMemStream: { parameters: ["pointer", "u32"], result: "pointer" },
});
// lib.symbols.SHCreateMemStream(pInit, cbInit)
// pInit : BYTE* optional -> "pointer"
// cbInit : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* SHCreateMemStream(
uint8_t* pInit,
uint32_t cbInit);
C, "SHLWAPI.dll");
// $ffi->SHCreateMemStream(pInit, cbInit);
// pInit : BYTE* optional
// cbInit : 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);
Pointer SHCreateMemStream(
byte[] pInit, // BYTE* optional
int cbInit // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun SHCreateMemStream = SHCreateMemStream(
pInit : UInt8*, # BYTE* optional
cbInit : 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 SHCreateMemStreamNative = Pointer<Void> Function(Pointer<Uint8>, Uint32);
typedef SHCreateMemStreamDart = Pointer<Void> Function(Pointer<Uint8>, int);
final SHCreateMemStream = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<SHCreateMemStreamNative, SHCreateMemStreamDart>('SHCreateMemStream');
// pInit : BYTE* optional -> Pointer<Uint8>
// cbInit : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHCreateMemStream(
pInit: Pointer; // BYTE* optional
cbInit: DWORD // DWORD
): Pointer; stdcall;
external 'SHLWAPI.dll' name 'SHCreateMemStream';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHCreateMemStream"
c_SHCreateMemStream :: Ptr Word8 -> Word32 -> IO (Ptr ())
-- pInit : BYTE* optional -> Ptr Word8
-- cbInit : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shcreatememstream =
foreign "SHCreateMemStream"
((ptr uint8_t) @-> uint32_t @-> returning (ptr void))
(* pInit : BYTE* optional -> (ptr uint8_t) *)
(* cbInit : 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 ("SHCreateMemStream" shcreate-mem-stream :convention :stdcall) :pointer
(p-init :pointer) ; BYTE* optional
(cb-init :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHCreateMemStream = Win32::API::More->new('SHLWAPI',
'LPVOID SHCreateMemStream(LPVOID pInit, DWORD cbInit)');
# my $ret = $SHCreateMemStream->Call($pInit, $cbInit);
# pInit : BYTE* optional -> LPVOID
# cbInit : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型