OleFlushClipboard
関数シグネチャ
// OLE32.dll
#include <windows.h>
HRESULT OleFlushClipboard(void);パラメーターなし。戻り値: HRESULT
公式ドキュメント
クリップボードのシャットダウンシーケンスを実行します。また、OleSetClipboard 関数によってクリップボードに置かれた IDataObject ポインターを解放します。
戻り値
この関数は成功すると S_OK を返します。その他に返される可能性のある値は次のとおりです。
| 戻り値 | 説明 |
|---|---|
| OleFlushClipboard 内で使用される Windows の OpenClipboard 関数が失敗しました。 | |
| OleFlushClipboard 内で使用される Windows の CloseClipboard 関数が失敗しました。 |
解説(Remarks)
OleFlushClipboard は、データオブジェクトのデータをクリップボードにレンダリングし、そのデータオブジェクトへの IDataObject ポインターを解放します。データオブジェクトをクリップボードに置いたアプリケーションが実行されている間、クリップボードはデータオブジェクトへのポインターのみを保持するため、メモリを節約できます。クリップボード操作のソースとして動作するアプリケーションを作成する場合、ユーザーがアプリケーションを終了したときなど、アプリケーションが閉じられる際に OleFlushClipboard 関数を呼び出すことができます。OleFlushClipboard を呼び出すことで、アプリケーションのシャットダウン後も OLE オブジェクトの貼り付けおよびリンク貼り付けが可能になります。
OleFlushClipboard を呼び出す前に、OleIsCurrentClipboard 関数を呼び出すことで、データがまだクリップボード上にあるかどうかを簡単に確認できます。
OleFlushClipboard は、OLE 1 互換フォーマットを含め、データ転送オブジェクトが提供するすべてのフォーマットをクリップボード上に残すため、アプリケーションのシャットダウン後もそれらを利用できます。OLE 1 互換フォーマットに加えて、これらにはグローバルハンドルメディア上で提供されるすべてのフォーマット(TYMED_FILE を除くすべて)で、ターゲットデバイスを NULL としてフォーマットされたものが含まれます。たとえば、データソースアプリケーションが特定のクリップボードフォーマット(たとえば cfFOO)を IStorage オブジェクト上で提供し、OleFlushClipboard 関数を呼び出すと、そのストレージオブジェクトはメモリにコピーされ、hglobal メモリハンドルがクリップボードに置かれます。
クリップボード上の情報を取得するには、別のアプリケーションから OleGetClipboard 関数を呼び出すことができます。これによりデフォルトのデータオブジェクトが作成され、クリップボードからの hglobal は再びストレージオブジェクトになります。さらに、FORMATETC 列挙子および IDataObject::QueryGetData メソッドは、元のクリップボードフォーマット(cfFOO)が再び TYMED_ISTORAGE 上で利用可能になったことを正しく示します。
クリップボードを空にするには、パラメーターに NULL 値を指定して OleSetClipboard 関数を呼び出します。シャットダウン後にクリップボードにデータを残す必要がない場合、または標準の Windows クリップボード関数を使用してデータをクリップボードに置く場合は、アプリケーションは閉じる際にこれを呼び出すべきです。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLE32.dll
#include <windows.h>
HRESULT OleFlushClipboard(void);[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleFlushClipboard();<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleFlushClipboard() As Integer
End FunctionDeclare PtrSafe Function OleFlushClipboard Lib "ole32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
OleFlushClipboard = ctypes.windll.ole32.OleFlushClipboard
OleFlushClipboard.restype = ctypes.c_int
OleFlushClipboard.argtypes = []require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLE32.dll')
OleFlushClipboard = Fiddle::Function.new(
lib['OleFlushClipboard'],
[],
Fiddle::TYPE_INT)#[link(name = "ole32")]
extern "system" {
fn OleFlushClipboard() -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleFlushClipboard();
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleFlushClipboard' -Namespace Win32 -PassThru
# $api::OleFlushClipboard()#uselib "OLE32.dll"
#func global OleFlushClipboard "OleFlushClipboard"
; OleFlushClipboard ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLE32.dll"
#cfunc global OleFlushClipboard "OleFlushClipboard"
; res = OleFlushClipboard(); HRESULT OleFlushClipboard()
#uselib "OLE32.dll"
#cfunc global OleFlushClipboard "OleFlushClipboard"
; res = OleFlushClipboard()import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ole32 = windows.NewLazySystemDLL("OLE32.dll")
procOleFlushClipboard = ole32.NewProc("OleFlushClipboard")
)
r1, _, err := procOleFlushClipboard.Call()
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction OleFlushClipboard: Integer; stdcall;
external 'OLE32.dll' name 'OleFlushClipboard';result := DllCall("OLE32\OleFlushClipboard", "Int")●OleFlushClipboard() = DLL("OLE32.dll", "int OleFlushClipboard()")
# 呼び出し: OleFlushClipboard()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ole32" fn OleFlushClipboard() callconv(std.os.windows.WINAPI) i32;proc OleFlushClipboard(): int32 {.importc: "OleFlushClipboard", stdcall, dynlib: "OLE32.dll".}pragma(lib, "ole32");
extern(Windows)
int OleFlushClipboard();ccall((:OleFlushClipboard, "OLE32.dll"), stdcall, Int32,
(),
)
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t OleFlushClipboard(void);
]]
local ole32 = ffi.load("ole32")
-- ole32.OleFlushClipboard()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const OleFlushClipboard = lib.func('__stdcall', 'OleFlushClipboard', 'int32_t', []);
// OleFlushClipboard()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLE32.dll", {
OleFlushClipboard: { parameters: [], result: "i32" },
});
// lib.symbols.OleFlushClipboard()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t OleFlushClipboard(void);
C, "OLE32.dll");
// $ffi->OleFlushClipboard();
// 構造体/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 OleFlushClipboard();
}@[Link("ole32")]
lib LibOLE32
fun OleFlushClipboard = OleFlushClipboard() : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef OleFlushClipboardNative = Int32 Function();
typedef OleFlushClipboardDart = int Function();
final OleFlushClipboard = DynamicLibrary.open('OLE32.dll')
.lookupFunction<OleFlushClipboardNative, OleFlushClipboardDart>('OleFlushClipboard');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OleFlushClipboard: Integer; stdcall;
external 'OLE32.dll' name 'OleFlushClipboard';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OleFlushClipboard"
c_OleFlushClipboard :: IO Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let oleflushclipboard =
foreign "OleFlushClipboard"
(void @-> returning int32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)
(cffi:defcfun ("OleFlushClipboard" ole-flush-clipboard :convention :stdcall) :int32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OleFlushClipboard = Win32::API::More->new('OLE32',
'int OleFlushClipboard()');
# my $ret = $OleFlushClipboard->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- i IDataObject
- f OleGetClipboard — OLEクリップボードのデータオブジェクトを取得する。
- f OleIsCurrentClipboard — 指定データオブジェクトが現在のクリップボード内容か判定する。
- f OleSetClipboard — データオブジェクトをOLEクリップボードに設定する。