ホーム › System.ApplicationInstallationAndServicing › MsiRecordReadStream
MsiRecordReadStream
関数レコードのフィールドからストリームデータを読み取る。
シグネチャ
// msi.dll
#include <windows.h>
DWORD MsiRecordReadStream(
MSIHANDLE hRecord,
DWORD iField,
LPSTR szDataBuf, // optional
DWORD* pcbDataBuf
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hRecord | MSIHANDLE | in | レコードへのハンドル。 |
| iField | DWORD | in | レコードのフィールドを指定します。 |
| szDataBuf | LPSTR | outoptional | ストリーム フィールドを受け取るバッファー。コピー先バッファーがコピー元バッファーと同じか、それ以上のサイズであることを確認してください。「解説」セクションを参照してください。 |
| pcbDataBuf | DWORD* | inout | 入力および出力のバッファー数を指定します。入力時はバッファーの全体サイズを表します。出力時はバッファーに実際に書き込まれたバイト数を表します。「解説」セクションを参照してください。 |
戻り値の型: DWORD
公式ドキュメント
MsiRecordReadStream 関数は、レコードのストリーム フィールドからバッファーへバイトを読み取ります。
戻り値
この関数は UINT を返します。
解説(Remarks)
ストリームを読み取るには、関数を呼び出すたびにストリームからバッファーへ転送するバイト数を pcbDataBuf に設定します。戻り時に、 MsiRecordReadStream は pcbDataBuf を実際に転送されたバイト数にリセットします。バッファーがストリームより小さい場合、バッファーがいっぱいになるとストリームの位置が再設定され、ストリーム内の次のデータが次回の関数呼び出しで転送されます。利用可能なバイトがなくなると、 MsiRecordReadStream は ERROR_SUCCESS を返します。
szDataBuf に 0 を渡すと、pcbDataBuf はストリーム内で読み取り残っているバイト数にリセットされます。
次のコード サンプルは、hRecord で指定されたレコードのフィールド 1 にあるストリームから読み取り、ストリーム全体を 8 バイトずつ読み取ります。
char szBuffer[8];
PMSIHANDLE hRecord;
DWORD cbBuf = sizeof(szBuffer);
do
{
if (MsiRecordReadStream(hRecord, 1, szBuffer,
&cbBuf) != ERROR_SUCCESS)
break; /* error */
}
while (cbBuf == 8); //continue reading the stream while you receive a full buffer
//cbBuf will be less once you reach the end of the stream and cannot fill your
//buffer with stream data
次も参照してください。 OLE Limitations on Streams。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll
#include <windows.h>
DWORD MsiRecordReadStream(
MSIHANDLE hRecord,
DWORD iField,
LPSTR szDataBuf, // optional
DWORD* pcbDataBuf
);[DllImport("msi.dll", ExactSpelling = true)]
static extern uint MsiRecordReadStream(
uint hRecord, // MSIHANDLE
uint iField, // DWORD
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szDataBuf, // LPSTR optional, out
ref uint pcbDataBuf // DWORD* in/out
);<DllImport("msi.dll", ExactSpelling:=True)>
Public Shared Function MsiRecordReadStream(
hRecord As UInteger, ' MSIHANDLE
iField As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPStr)> szDataBuf As System.Text.StringBuilder, ' LPSTR optional, out
ByRef pcbDataBuf As UInteger ' DWORD* in/out
) As UInteger
End Function' hRecord : MSIHANDLE
' iField : DWORD
' szDataBuf : LPSTR optional, out
' pcbDataBuf : DWORD* in/out
Declare PtrSafe Function MsiRecordReadStream Lib "msi" ( _
ByVal hRecord As Long, _
ByVal iField As Long, _
ByVal szDataBuf As String, _
ByRef pcbDataBuf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
MsiRecordReadStream = ctypes.windll.msi.MsiRecordReadStream
MsiRecordReadStream.restype = wintypes.DWORD
MsiRecordReadStream.argtypes = [
wintypes.DWORD, # hRecord : MSIHANDLE
wintypes.DWORD, # iField : DWORD
wintypes.LPSTR, # szDataBuf : LPSTR optional, out
ctypes.POINTER(wintypes.DWORD), # pcbDataBuf : DWORD* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiRecordReadStream = Fiddle::Function.new(
lib['MsiRecordReadStream'],
[
-Fiddle::TYPE_INT, # hRecord : MSIHANDLE
-Fiddle::TYPE_INT, # iField : DWORD
Fiddle::TYPE_VOIDP, # szDataBuf : LPSTR optional, out
Fiddle::TYPE_VOIDP, # pcbDataBuf : DWORD* in/out
],
-Fiddle::TYPE_INT)#[link(name = "msi")]
extern "system" {
fn MsiRecordReadStream(
hRecord: u32, // MSIHANDLE
iField: u32, // DWORD
szDataBuf: *mut u8, // LPSTR optional, out
pcbDataBuf: *mut u32 // DWORD* in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll")]
public static extern uint MsiRecordReadStream(uint hRecord, uint iField, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szDataBuf, ref uint pcbDataBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiRecordReadStream' -Namespace Win32 -PassThru
# $api::MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf)#uselib "msi.dll"
#func global MsiRecordReadStream "MsiRecordReadStream" sptr, sptr, sptr, sptr
; MsiRecordReadStream hRecord, iField, varptr(szDataBuf), varptr(pcbDataBuf) ; 戻り値は stat
; hRecord : MSIHANDLE -> "sptr"
; iField : DWORD -> "sptr"
; szDataBuf : LPSTR optional, out -> "sptr"
; pcbDataBuf : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "msi.dll" #cfunc global MsiRecordReadStream "MsiRecordReadStream" int, int, var, var ; res = MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf) ; hRecord : MSIHANDLE -> "int" ; iField : DWORD -> "int" ; szDataBuf : LPSTR optional, out -> "var" ; pcbDataBuf : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll" #cfunc global MsiRecordReadStream "MsiRecordReadStream" int, int, sptr, sptr ; res = MsiRecordReadStream(hRecord, iField, varptr(szDataBuf), varptr(pcbDataBuf)) ; hRecord : MSIHANDLE -> "int" ; iField : DWORD -> "int" ; szDataBuf : LPSTR optional, out -> "sptr" ; pcbDataBuf : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD MsiRecordReadStream(MSIHANDLE hRecord, DWORD iField, LPSTR szDataBuf, DWORD* pcbDataBuf) #uselib "msi.dll" #cfunc global MsiRecordReadStream "MsiRecordReadStream" int, int, var, var ; res = MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf) ; hRecord : MSIHANDLE -> "int" ; iField : DWORD -> "int" ; szDataBuf : LPSTR optional, out -> "var" ; pcbDataBuf : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD MsiRecordReadStream(MSIHANDLE hRecord, DWORD iField, LPSTR szDataBuf, DWORD* pcbDataBuf) #uselib "msi.dll" #cfunc global MsiRecordReadStream "MsiRecordReadStream" int, int, intptr, intptr ; res = MsiRecordReadStream(hRecord, iField, varptr(szDataBuf), varptr(pcbDataBuf)) ; hRecord : MSIHANDLE -> "int" ; iField : DWORD -> "int" ; szDataBuf : LPSTR optional, out -> "intptr" ; pcbDataBuf : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiRecordReadStream = msi.NewProc("MsiRecordReadStream")
)
// hRecord (MSIHANDLE), iField (DWORD), szDataBuf (LPSTR optional, out), pcbDataBuf (DWORD* in/out)
r1, _, err := procMsiRecordReadStream.Call(
uintptr(hRecord),
uintptr(iField),
uintptr(szDataBuf),
uintptr(pcbDataBuf),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiRecordReadStream(
hRecord: DWORD; // MSIHANDLE
iField: DWORD; // DWORD
szDataBuf: PAnsiChar; // LPSTR optional, out
pcbDataBuf: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'msi.dll' name 'MsiRecordReadStream';result := DllCall("msi\MsiRecordReadStream"
, "UInt", hRecord ; MSIHANDLE
, "UInt", iField ; DWORD
, "Ptr", szDataBuf ; LPSTR optional, out
, "Ptr", pcbDataBuf ; DWORD* in/out
, "UInt") ; return: DWORD●MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf) = DLL("msi.dll", "dword MsiRecordReadStream(dword, dword, char*, void*)")
# 呼び出し: MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf)
# hRecord : MSIHANDLE -> "dword"
# iField : DWORD -> "dword"
# szDataBuf : LPSTR optional, out -> "char*"
# pcbDataBuf : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "msi" fn MsiRecordReadStream(
hRecord: u32, // MSIHANDLE
iField: u32, // DWORD
szDataBuf: [*c]u8, // LPSTR optional, out
pcbDataBuf: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;proc MsiRecordReadStream(
hRecord: uint32, # MSIHANDLE
iField: uint32, # DWORD
szDataBuf: ptr char, # LPSTR optional, out
pcbDataBuf: ptr uint32 # DWORD* in/out
): uint32 {.importc: "MsiRecordReadStream", stdcall, dynlib: "msi.dll".}pragma(lib, "msi");
extern(Windows)
uint MsiRecordReadStream(
uint hRecord, // MSIHANDLE
uint iField, // DWORD
char* szDataBuf, // LPSTR optional, out
uint* pcbDataBuf // DWORD* in/out
);ccall((:MsiRecordReadStream, "msi.dll"), stdcall, UInt32,
(UInt32, UInt32, Ptr{UInt8}, Ptr{UInt32}),
hRecord, iField, szDataBuf, pcbDataBuf)
# hRecord : MSIHANDLE -> UInt32
# iField : DWORD -> UInt32
# szDataBuf : LPSTR optional, out -> Ptr{UInt8}
# pcbDataBuf : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiRecordReadStream(
uint32_t hRecord,
uint32_t iField,
char* szDataBuf,
uint32_t* pcbDataBuf);
]]
local msi = ffi.load("msi")
-- msi.MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf)
-- hRecord : MSIHANDLE
-- iField : DWORD
-- szDataBuf : LPSTR optional, out
-- pcbDataBuf : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiRecordReadStream = lib.func('__stdcall', 'MsiRecordReadStream', 'uint32_t', ['uint32_t', 'uint32_t', 'char *', 'uint32_t *']);
// MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf)
// hRecord : MSIHANDLE -> 'uint32_t'
// iField : DWORD -> 'uint32_t'
// szDataBuf : LPSTR optional, out -> 'char *'
// pcbDataBuf : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiRecordReadStream: { parameters: ["u32", "u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf)
// hRecord : MSIHANDLE -> "u32"
// iField : DWORD -> "u32"
// szDataBuf : LPSTR optional, out -> "buffer"
// pcbDataBuf : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiRecordReadStream(
uint32_t hRecord,
uint32_t iField,
char* szDataBuf,
uint32_t* pcbDataBuf);
C, "msi.dll");
// $ffi->MsiRecordReadStream(hRecord, iField, szDataBuf, pcbDataBuf);
// hRecord : MSIHANDLE
// iField : DWORD
// szDataBuf : LPSTR optional, out
// pcbDataBuf : DWORD* in/out
// 構造体/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 Msi extends StdCallLibrary {
Msi INSTANCE = Native.load("msi", Msi.class);
int MsiRecordReadStream(
int hRecord, // MSIHANDLE
int iField, // DWORD
byte[] szDataBuf, // LPSTR optional, out
IntByReference pcbDataBuf // DWORD* in/out
);
}@[Link("msi")]
lib Libmsi
fun MsiRecordReadStream = MsiRecordReadStream(
hRecord : UInt32, # MSIHANDLE
iField : UInt32, # DWORD
szDataBuf : UInt8*, # LPSTR optional, out
pcbDataBuf : UInt32* # DWORD* in/out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiRecordReadStreamNative = Uint32 Function(Uint32, Uint32, Pointer<Utf8>, Pointer<Uint32>);
typedef MsiRecordReadStreamDart = int Function(int, int, Pointer<Utf8>, Pointer<Uint32>);
final MsiRecordReadStream = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiRecordReadStreamNative, MsiRecordReadStreamDart>('MsiRecordReadStream');
// hRecord : MSIHANDLE -> Uint32
// iField : DWORD -> Uint32
// szDataBuf : LPSTR optional, out -> Pointer<Utf8>
// pcbDataBuf : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiRecordReadStream(
hRecord: DWORD; // MSIHANDLE
iField: DWORD; // DWORD
szDataBuf: PAnsiChar; // LPSTR optional, out
pcbDataBuf: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'msi.dll' name 'MsiRecordReadStream';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiRecordReadStream"
c_MsiRecordReadStream :: Word32 -> Word32 -> CString -> Ptr Word32 -> IO Word32
-- hRecord : MSIHANDLE -> Word32
-- iField : DWORD -> Word32
-- szDataBuf : LPSTR optional, out -> CString
-- pcbDataBuf : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msirecordreadstream =
foreign "MsiRecordReadStream"
(uint32_t @-> uint32_t @-> string @-> (ptr uint32_t) @-> returning uint32_t)
(* hRecord : MSIHANDLE -> uint32_t *)
(* iField : DWORD -> uint32_t *)
(* szDataBuf : LPSTR optional, out -> string *)
(* pcbDataBuf : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiRecordReadStream" msi-record-read-stream :convention :stdcall) :uint32
(h-record :uint32) ; MSIHANDLE
(i-field :uint32) ; DWORD
(sz-data-buf :pointer) ; LPSTR optional, out
(pcb-data-buf :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiRecordReadStream = Win32::API::More->new('msi',
'DWORD MsiRecordReadStream(DWORD hRecord, DWORD iField, LPSTR szDataBuf, LPVOID pcbDataBuf)');
# my $ret = $MsiRecordReadStream->Call($hRecord, $iField, $szDataBuf, $pcbDataBuf);
# hRecord : MSIHANDLE -> DWORD
# iField : DWORD -> DWORD
# szDataBuf : LPSTR optional, out -> LPSTR
# pcbDataBuf : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。