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

IStream_Size

関数
ストリームの全体サイズをバイト数で取得する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT IStream_Size(
    IStream* pstm,
    ULONGLONG* pui
);

パラメーター

名前方向説明
pstmIStream*inサイズを取得する対象のストリームの IStream インターフェイスへのポインターです。
puiULONGLONG*outストリームのサイズを受け取る ULARGE_INTEGER 構造体へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

指定したストリームのサイズをバイト単位で取得します。

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合は COM の失敗コードを返します。発生し得るエラーコードの詳細については、IStream::Stat を参照してください。

解説(Remarks)

この関数は、指定したストリームオブジェクトの IStream::Stat メソッドを呼び出してストリームのサイズを取得します。次に、IStream::Stat が返す STATSTG 構造体の cbSize メンバーの値を、pui が指す ULARGE_INTEGER 構造体にコピーします。関数が失敗した場合、ULARGE_INTEGER 構造体の内容は未定義です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_Size(
    IStream* pstm,
    ULONGLONG* pui
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int IStream_Size(
    IntPtr pstm,   // IStream*
    out ulong pui   // ULONGLONG* out
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function IStream_Size(
    pstm As IntPtr,   ' IStream*
    <Out> ByRef pui As ULong   ' ULONGLONG* out
) As Integer
End Function
' pstm : IStream*
' pui : ULONGLONG* out
Declare PtrSafe Function IStream_Size Lib "shlwapi" ( _
    ByVal pstm As LongPtr, _
    ByRef pui As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IStream_Size = ctypes.windll.shlwapi.IStream_Size
IStream_Size.restype = ctypes.c_int
IStream_Size.argtypes = [
    ctypes.c_void_p,  # pstm : IStream*
    ctypes.POINTER(ctypes.c_ulonglong),  # pui : ULONGLONG* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
IStream_Size = Fiddle::Function.new(
  lib['IStream_Size'],
  [
    Fiddle::TYPE_VOIDP,  # pstm : IStream*
    Fiddle::TYPE_VOIDP,  # pui : ULONGLONG* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn IStream_Size(
        pstm: *mut core::ffi::c_void,  // IStream*
        pui: *mut u64  // ULONGLONG* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int IStream_Size(IntPtr pstm, out ulong pui);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_IStream_Size' -Namespace Win32 -PassThru
# $api::IStream_Size(pstm, pui)
#uselib "SHLWAPI.dll"
#func global IStream_Size "IStream_Size" sptr, sptr
; IStream_Size pstm, varptr(pui)   ; 戻り値は stat
; pstm : IStream* -> "sptr"
; pui : ULONGLONG* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global IStream_Size "IStream_Size" sptr, var
; res = IStream_Size(pstm, pui)
; pstm : IStream* -> "sptr"
; pui : ULONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT IStream_Size(IStream* pstm, ULONGLONG* pui)
#uselib "SHLWAPI.dll"
#cfunc global IStream_Size "IStream_Size" intptr, var
; res = IStream_Size(pstm, pui)
; pstm : IStream* -> "intptr"
; pui : ULONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procIStream_Size = shlwapi.NewProc("IStream_Size")
)

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

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

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

foreign import stdcall safe "IStream_Size"
  c_IStream_Size :: Ptr () -> Ptr Word64 -> IO Int32
-- pstm : IStream* -> Ptr ()
-- pui : ULONGLONG* out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let istream_size =
  foreign "IStream_Size"
    ((ptr void) @-> (ptr uint64_t) @-> returning int32_t)
(* pstm : IStream* -> (ptr void) *)
(* pui : ULONGLONG* out -> (ptr uint64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("IStream_Size" istream-size :convention :stdcall) :int32
  (pstm :pointer)   ; IStream*
  (pui :pointer))   ; ULONGLONG* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IStream_Size = Win32::API::More->new('SHLWAPI',
    'int IStream_Size(LPVOID pstm, LPVOID pui)');
# my $ret = $IStream_Size->Call($pstm, $pui);
# pstm : IStream* -> LPVOID
# pui : ULONGLONG* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型