Win32 API 日本語リファレンス
ホームSystem.Ole › OleSaveToStream

OleSaveToStream

関数
オブジェクトのCLSIDと状態をストリームに保存する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleSaveToStream(
    IPersistStream* pPStm,
    IStream* pStm
);

パラメーター

名前方向説明
pPStmIPersistStream*inストリームに保存するオブジェクトの IPersistStream インターフェイスへのポインター。pPStm パラメーターを NULL にすることはできません。
pStmIStream*inオブジェクトを保存するストリームの IStream インターフェイスへのポインター。

戻り値の型: HRESULT

公式ドキュメント

OleSaveToStream 関数 (ole2.h) は、IPersistStream インターフェイスを持つオブジェクトを指定したストリームに保存します。

戻り値

この関数は、成功すると S_OK を返します。その他に返される可能性のある値には、次のものがあります。

戻り値 説明
STGMEDIUM_E_FULL
ディスク領域が不足しているため、オブジェクトを保存できませんでした。
OLE_E_BLANK
pPStm パラメーターが NULL です。

この関数は、WriteClassStm 関数または IPersistStream::Save メソッドが返すエラー値のいずれかを返すこともあります。

解説(Remarks)

この関数は、IPersistStream インターフェイスを実装するオブジェクトをストリームに保存する処理を簡略化します。このストリームでは、オブジェクトのデータの前にオブジェクトの CLSID が配置されます。ストリームを取得する際、CLSID によって適切なコードをデータに関連付けることができます。OleSaveToStream 関数は、次の処理を行います。

対になるヘルパー関数 OleLoadFromStream は、この方法で保存されたオブジェクトを読み込みます。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT OleSaveToStream(
    IPersistStream* pPStm,
    IStream* pStm
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleSaveToStream(
    IntPtr pPStm,   // IPersistStream*
    IntPtr pStm   // IStream*
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleSaveToStream(
    pPStm As IntPtr,   ' IPersistStream*
    pStm As IntPtr   ' IStream*
) As Integer
End Function
' pPStm : IPersistStream*
' pStm : IStream*
Declare PtrSafe Function OleSaveToStream Lib "ole32" ( _
    ByVal pPStm As LongPtr, _
    ByVal pStm As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OleSaveToStream = ctypes.windll.ole32.OleSaveToStream
OleSaveToStream.restype = ctypes.c_int
OleSaveToStream.argtypes = [
    ctypes.c_void_p,  # pPStm : IPersistStream*
    ctypes.c_void_p,  # pStm : IStream*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleSaveToStream = ole32.NewProc("OleSaveToStream")
)

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

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

typedef OleSaveToStreamNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef OleSaveToStreamDart = int Function(Pointer<Void>, Pointer<Void>);
final OleSaveToStream = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<OleSaveToStreamNative, OleSaveToStreamDart>('OleSaveToStream');
// pPStm : IPersistStream* -> Pointer<Void>
// pStm : IStream* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleSaveToStream(
  pPStm: Pointer;   // IPersistStream*
  pStm: Pointer   // IStream*
): Integer; stdcall;
  external 'OLE32.dll' name 'OleSaveToStream';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OleSaveToStream"
  c_OleSaveToStream :: Ptr () -> Ptr () -> IO Int32
-- pPStm : IPersistStream* -> Ptr ()
-- pStm : IStream* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let olesavetostream =
  foreign "OleSaveToStream"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* pPStm : IPersistStream* -> (ptr void) *)
(* pStm : IStream* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("OleSaveToStream" ole-save-to-stream :convention :stdcall) :int32
  (p-pstm :pointer)   ; IPersistStream*
  (p-stm :pointer))   ; IStream*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleSaveToStream = Win32::API::More->new('OLE32',
    'int OleSaveToStream(LPVOID pPStm, LPVOID pStm)');
# my $ret = $OleSaveToStream->Call($pPStm, $pStm);
# pPStm : IPersistStream* -> LPVOID
# pStm : IStream* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型