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

IStream_Read

関数
ストリームから指定バイト数を確実に読み取る。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT IStream_Read(
    IStream* pstm,
    void* pv,
    DWORD cb
);

パラメーター

名前方向説明
pstmIStream*in読み取り元となるストリームの IStream インターフェイスへのポインターです。
pvvoid*outpstm からのストリームデータを受け取るバッファーへのポインターです。このバッファーは少なくとも cb バイトのサイズが必要です。
cbDWORDinこの関数が入力ストリームから読み取りを試みるデータのバイト数です。

戻り値の型: HRESULT

公式ドキュメント

指定したストリームからバイトを読み取り、すべてのバイトが正常に読み取られたかどうかを示す値を返します。

戻り値

型: HRESULT

ストリームから指定したバイト数を正常に読み取った場合は S_OK を返し、それ以外の場合は COM の失敗コードを返します。特に、読み取りは成功したものの cb バイト未満しか読み取れなかった場合、この関数は E_FAIL を返します。

解説(Remarks)

この関数は ISequentialStream::Read メソッドを呼び出して、指定したストリームからバッファーへデータを読み取ります。何らかの理由で関数が失敗した場合、出力バッファーの内容および入力ストリームの読み取りポインターの位置は未定義となります。

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

各言語での呼び出し定義

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

HRESULT IStream_Read(
    IStream* pstm,
    void* pv,
    DWORD cb
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int IStream_Read(
    IntPtr pstm,   // IStream*
    IntPtr pv,   // void* out
    uint cb   // DWORD
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function IStream_Read(
    pstm As IntPtr,   ' IStream*
    pv As IntPtr,   ' void* out
    cb As UInteger   ' DWORD
) As Integer
End Function
' pstm : IStream*
' pv : void* out
' cb : DWORD
Declare PtrSafe Function IStream_Read Lib "shlwapi" ( _
    ByVal pstm As LongPtr, _
    ByVal pv As LongPtr, _
    ByVal cb As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IStream_Read = ctypes.windll.shlwapi.IStream_Read
IStream_Read.restype = ctypes.c_int
IStream_Read.argtypes = [
    ctypes.c_void_p,  # pstm : IStream*
    ctypes.POINTER(None),  # pv : void* out
    wintypes.DWORD,  # cb : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
IStream_Read = Fiddle::Function.new(
  lib['IStream_Read'],
  [
    Fiddle::TYPE_VOIDP,  # pstm : IStream*
    Fiddle::TYPE_VOIDP,  # pv : void* out
    -Fiddle::TYPE_INT,  # cb : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn IStream_Read(
        pstm: *mut core::ffi::c_void,  // IStream*
        pv: *mut (),  // void* out
        cb: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int IStream_Read(IntPtr pstm, IntPtr pv, uint cb);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_IStream_Read' -Namespace Win32 -PassThru
# $api::IStream_Read(pstm, pv, cb)
#uselib "SHLWAPI.dll"
#func global IStream_Read "IStream_Read" sptr, sptr, sptr
; IStream_Read pstm, pv, cb   ; 戻り値は stat
; pstm : IStream* -> "sptr"
; pv : void* out -> "sptr"
; cb : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global IStream_Read "IStream_Read" sptr, sptr, int
; res = IStream_Read(pstm, pv, cb)
; pstm : IStream* -> "sptr"
; pv : void* out -> "sptr"
; cb : DWORD -> "int"
; HRESULT IStream_Read(IStream* pstm, void* pv, DWORD cb)
#uselib "SHLWAPI.dll"
#cfunc global IStream_Read "IStream_Read" intptr, intptr, int
; res = IStream_Read(pstm, pv, cb)
; pstm : IStream* -> "intptr"
; pv : void* out -> "intptr"
; cb : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procIStream_Read = shlwapi.NewProc("IStream_Read")
)

// pstm (IStream*), pv (void* out), cb (DWORD)
r1, _, err := procIStream_Read.Call(
	uintptr(pstm),
	uintptr(pv),
	uintptr(cb),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function IStream_Read(
  pstm: Pointer;   // IStream*
  pv: Pointer;   // void* out
  cb: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'IStream_Read';
result := DllCall("SHLWAPI\IStream_Read"
    , "Ptr", pstm   ; IStream*
    , "Ptr", pv   ; void* out
    , "UInt", cb   ; DWORD
    , "Int")   ; return: HRESULT
●IStream_Read(pstm, pv, cb) = DLL("SHLWAPI.dll", "int IStream_Read(void*, void*, dword)")
# 呼び出し: IStream_Read(pstm, pv, cb)
# pstm : IStream* -> "void*"
# pv : void* out -> "void*"
# cb : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef IStream_ReadNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef IStream_ReadDart = int Function(Pointer<Void>, Pointer<Void>, int);
final IStream_Read = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<IStream_ReadNative, IStream_ReadDart>('IStream_Read');
// pstm : IStream* -> Pointer<Void>
// pv : void* out -> Pointer<Void>
// cb : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IStream_Read(
  pstm: Pointer;   // IStream*
  pv: Pointer;   // void* out
  cb: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'IStream_Read';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "IStream_Read"
  c_IStream_Read :: Ptr () -> Ptr () -> Word32 -> IO Int32
-- pstm : IStream* -> Ptr ()
-- pv : void* out -> Ptr ()
-- cb : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let istream_read =
  foreign "IStream_Read"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* pstm : IStream* -> (ptr void) *)
(* pv : void* out -> (ptr void) *)
(* cb : 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 ("IStream_Read" istream-read :convention :stdcall) :int32
  (pstm :pointer)   ; IStream*
  (pv :pointer)   ; void* out
  (cb :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IStream_Read = Win32::API::More->new('SHLWAPI',
    'int IStream_Read(LPVOID pstm, LPVOID pv, DWORD cb)');
# my $ret = $IStream_Read->Call($pstm, $pv, $cb);
# pstm : IStream* -> LPVOID
# pv : void* out -> LPVOID
# cb : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型