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

OleSave

関数
OLEオブジェクトを指定ストレージに保存する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleSave(
    IPersistStorage* pPS,
    IStorage* pStg,
    BOOL fSameAsLoad
);

パラメーター

名前方向説明
pPSIPersistStorage*in保存対象のオブジェクト上の IPersistStorage インターフェイスへのポインターです。
pStgIStorage*inpPS で示されるオブジェクトの保存先となるストレージオブジェクト上の IStorage インターフェイスへのポインターです。
fSameAsLoadBOOLinTRUE は、pStg がオブジェクトの読み込みまたは作成に使用したものと同じストレージオブジェクトであることを示します。FALSE は、pStg が別のストレージオブジェクトから読み込まれた、または作成されたものであることを示します。

戻り値の型: HRESULT

公式ドキュメント

トランザクションモードで開かれているオブジェクトを、指定したストレージオブジェクトに保存します。

戻り値

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

戻り値 説明
STGMEDIUM_E_FULL
ディスク容量の不足により、オブジェクトを保存できませんでした。

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

解説(Remarks)

OleSave ヘルパー関数は、オブジェクトがトランザクションモードで開かれており、OLE が提供する複合ファイル実装を使用する指定のストレージオブジェクトに保存するという一般的な状況を処理します。トランザクションモードとは、オブジェクトへの変更が IStorage::Commit または IStorage::Revert のいずれかが呼び出されるまでバッファーに保持されることを意味します。それ以外の状況については、呼び出し元が IPersistStorage および IStorage インターフェイスを直接呼び出すことで処理できます。

OleSave は次の処理を行います。

注意 静的オブジェクトは CONTENTS という名前のストリームに保存されます。静的メタファイルオブジェクトは「配置可能メタファイル形式 (placeable metafile format)」で保存され、静的 DIB データは「DIB ファイル形式 (DIB file format)」で保存されます。これらの形式は、メタファイルおよび DIB に対する OLE 標準として定義されています。IStream インターフェイスまたはファイルを使用して (すなわち IDataObject::GetDataHere を介して) 転送されるすべてのデータは、これらの形式でなければなりません。また、既定のファイル形式がメタファイルまたは DIB であるすべてのオブジェクトは、これらの標準形式を使用してデータを CONTENTS ストリームに書き込む必要があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

OleSave = ctypes.windll.ole32.OleSave
OleSave.restype = ctypes.c_int
OleSave.argtypes = [
    ctypes.c_void_p,  # pPS : IPersistStorage*
    ctypes.c_void_p,  # pStg : IStorage*
    wintypes.BOOL,  # fSameAsLoad : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleSave = ole32.NewProc("OleSave")
)

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

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

typedef OleSaveNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32);
typedef OleSaveDart = int Function(Pointer<Void>, Pointer<Void>, int);
final OleSave = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<OleSaveNative, OleSaveDart>('OleSave');
// pPS : IPersistStorage* -> Pointer<Void>
// pStg : IStorage* -> Pointer<Void>
// fSameAsLoad : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleSave(
  pPS: Pointer;   // IPersistStorage*
  pStg: Pointer;   // IStorage*
  fSameAsLoad: BOOL   // BOOL
): Integer; stdcall;
  external 'OLE32.dll' name 'OleSave';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OleSave"
  c_OleSave :: Ptr () -> Ptr () -> CInt -> IO Int32
-- pPS : IPersistStorage* -> Ptr ()
-- pStg : IStorage* -> Ptr ()
-- fSameAsLoad : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let olesave =
  foreign "OleSave"
    ((ptr void) @-> (ptr void) @-> int32_t @-> returning int32_t)
(* pPS : IPersistStorage* -> (ptr void) *)
(* pStg : IStorage* -> (ptr void) *)
(* fSameAsLoad : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("OleSave" ole-save :convention :stdcall) :int32
  (p-ps :pointer)   ; IPersistStorage*
  (p-stg :pointer)   ; IStorage*
  (f-same-as-load :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleSave = Win32::API::More->new('OLE32',
    'int OleSave(LPVOID pPS, LPVOID pStg, BOOL fSameAsLoad)');
# my $ret = $OleSave->Call($pPS, $pStg, $fSameAsLoad);
# pPS : IPersistStorage* -> LPVOID
# pStg : IStorage* -> LPVOID
# fSameAsLoad : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型