OleSetClipboard
関数シグネチャ
// OLE32.dll
#include <windows.h>
HRESULT OleSetClipboard(
IDataObject* pDataObj
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pDataObj | IDataObject* | in | クリップボードに配置するデータの取得元となるデータオブジェクト上の IDataObject インターフェイスへのポインター。このパラメーターには NULL を指定できます。その場合、クリップボードは空にされます。 |
戻り値の型: HRESULT
公式ドキュメント
特定のデータオブジェクトへのポインターをクリップボードに配置します。これにより、データオブジェクトが OleGetClipboard 関数からアクセス可能になります。
戻り値
この関数は成功時に S_OK を返します。その他に返される可能性のある値は次のとおりです。
| 戻り値 | 説明 |
|---|---|
| OleSetClipboard 内で使用される OpenClipboard 関数が失敗しました。 | |
| OleSetClipboard 内で使用される EmptyClipboard 関数が失敗しました。 | |
| OleSetClipboard 内で使用される CloseClipboard 関数が失敗しました。 | |
| OleSetClipboard 内で使用される SetClipboardData 関数が失敗しました。 |
解説(Remarks)
クリップボード操作のソースとして動作できるアプリケーションを作成する場合は、次の手順を実行する必要があります。
- クリップボードにコピーまたは切り取られるデータ用のデータオブジェクト(IDataObject インターフェイスを実装したもの)を作成します。このオブジェクトは、OLE のドラッグアンドドロップ操作で使用するものと同じオブジェクトであるべきです。
- OleSetClipboard を呼び出して IDataObject ポインターをクリップボードに配置し、OleGetClipboard 関数からアクセスできるようにします。OleSetClipboard は、データオブジェクトに対して IUnknown::AddRef メソッドも呼び出します。
- 必要に応じて、データオブジェクトをクリップボードに配置した後でそれを解放し、アプリケーション内の IUnknown::AddRef カウンターを解放します。
- ユーザーがデータを切り取っている(ドキュメントから削除してクリップボードに置いている)場合は、ドキュメントからデータを削除します。
OleSetClipboard 関数は、クリップボードの所有権を内部の OLE ウィンドウハンドルに割り当てます。遅延レンダリングを可能にするため、データオブジェクトの参照カウントが 1 つ増加します。参照カウントは、OleFlushClipboard 関数の呼び出し、またはパラメーター値として NULL を指定した後続の OleSetClipboard の呼び出し(クリップボードをクリアします)によって減少します。
アプリケーションがクリップボードを開くと(直接的に、または OpenClipboard 関数を呼び出すことで間接的に)、クリップボードが閉じられるまで他のアプリケーションはそれを使用できません。クリップボードが現在他のアプリケーションによって開かれている場合、OleSetClipboard は失敗します。内部の OLE ウィンドウハンドルは、WM_RENDERFORMAT メッセージを、クリップボード上にあるデータオブジェクトの IDataObject 実装に委譲することで処理します。
OleSetClipboard のパラメーター値として NULL を指定すると、現在のクリップボードが空になります。クリップボードの内容が以前の OleSetClipboard 呼び出しの結果であり、かつクリップボードが解放されている場合、以前の呼び出しに渡された IDataObject ポインターが解放されます。クリップボードの所有者は、これを以前に提供したデータがクリップボード上に存在しなくなったことの合図として扱うべきです。
アプリケーションを閉じた後もデータをクリップボード上に残しておく必要がある場合は、NULL パラメーター値で OleSetClipboard を呼び出すのではなく、OleFlushClipboard を呼び出す必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLE32.dll
#include <windows.h>
HRESULT OleSetClipboard(
IDataObject* pDataObj
);[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleSetClipboard(
IntPtr pDataObj // IDataObject*
);<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleSetClipboard(
pDataObj As IntPtr ' IDataObject*
) As Integer
End Function' pDataObj : IDataObject*
Declare PtrSafe Function OleSetClipboard Lib "ole32" ( _
ByVal pDataObj As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
OleSetClipboard = ctypes.windll.ole32.OleSetClipboard
OleSetClipboard.restype = ctypes.c_int
OleSetClipboard.argtypes = [
ctypes.c_void_p, # pDataObj : IDataObject*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLE32.dll')
OleSetClipboard = Fiddle::Function.new(
lib['OleSetClipboard'],
[
Fiddle::TYPE_VOIDP, # pDataObj : IDataObject*
],
Fiddle::TYPE_INT)#[link(name = "ole32")]
extern "system" {
fn OleSetClipboard(
pDataObj: *mut core::ffi::c_void // IDataObject*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleSetClipboard(IntPtr pDataObj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleSetClipboard' -Namespace Win32 -PassThru
# $api::OleSetClipboard(pDataObj)#uselib "OLE32.dll"
#func global OleSetClipboard "OleSetClipboard" sptr
; OleSetClipboard pDataObj ; 戻り値は stat
; pDataObj : IDataObject* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLE32.dll"
#cfunc global OleSetClipboard "OleSetClipboard" sptr
; res = OleSetClipboard(pDataObj)
; pDataObj : IDataObject* -> "sptr"; HRESULT OleSetClipboard(IDataObject* pDataObj)
#uselib "OLE32.dll"
#cfunc global OleSetClipboard "OleSetClipboard" intptr
; res = OleSetClipboard(pDataObj)
; pDataObj : IDataObject* -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ole32 = windows.NewLazySystemDLL("OLE32.dll")
procOleSetClipboard = ole32.NewProc("OleSetClipboard")
)
// pDataObj (IDataObject*)
r1, _, err := procOleSetClipboard.Call(
uintptr(pDataObj),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction OleSetClipboard(
pDataObj: Pointer // IDataObject*
): Integer; stdcall;
external 'OLE32.dll' name 'OleSetClipboard';result := DllCall("OLE32\OleSetClipboard"
, "Ptr", pDataObj ; IDataObject*
, "Int") ; return: HRESULT●OleSetClipboard(pDataObj) = DLL("OLE32.dll", "int OleSetClipboard(void*)")
# 呼び出し: OleSetClipboard(pDataObj)
# pDataObj : IDataObject* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ole32" fn OleSetClipboard(
pDataObj: ?*anyopaque // IDataObject*
) callconv(std.os.windows.WINAPI) i32;proc OleSetClipboard(
pDataObj: pointer # IDataObject*
): int32 {.importc: "OleSetClipboard", stdcall, dynlib: "OLE32.dll".}pragma(lib, "ole32");
extern(Windows)
int OleSetClipboard(
void* pDataObj // IDataObject*
);ccall((:OleSetClipboard, "OLE32.dll"), stdcall, Int32,
(Ptr{Cvoid},),
pDataObj)
# pDataObj : IDataObject* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t OleSetClipboard(
void* pDataObj);
]]
local ole32 = ffi.load("ole32")
-- ole32.OleSetClipboard(pDataObj)
-- pDataObj : IDataObject*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const OleSetClipboard = lib.func('__stdcall', 'OleSetClipboard', 'int32_t', ['void *']);
// OleSetClipboard(pDataObj)
// pDataObj : IDataObject* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLE32.dll", {
OleSetClipboard: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.OleSetClipboard(pDataObj)
// pDataObj : IDataObject* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t OleSetClipboard(
void* pDataObj);
C, "OLE32.dll");
// $ffi->OleSetClipboard(pDataObj);
// pDataObj : IDataObject*
// 構造体/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 OleSetClipboard(
Pointer pDataObj // IDataObject*
);
}@[Link("ole32")]
lib LibOLE32
fun OleSetClipboard = OleSetClipboard(
pDataObj : Void* # IDataObject*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef OleSetClipboardNative = Int32 Function(Pointer<Void>);
typedef OleSetClipboardDart = int Function(Pointer<Void>);
final OleSetClipboard = DynamicLibrary.open('OLE32.dll')
.lookupFunction<OleSetClipboardNative, OleSetClipboardDart>('OleSetClipboard');
// pDataObj : IDataObject* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OleSetClipboard(
pDataObj: Pointer // IDataObject*
): Integer; stdcall;
external 'OLE32.dll' name 'OleSetClipboard';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OleSetClipboard"
c_OleSetClipboard :: Ptr () -> IO Int32
-- pDataObj : IDataObject* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let olesetclipboard =
foreign "OleSetClipboard"
((ptr void) @-> returning int32_t)
(* pDataObj : IDataObject* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)
(cffi:defcfun ("OleSetClipboard" ole-set-clipboard :convention :stdcall) :int32
(p-data-obj :pointer)) ; IDataObject*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OleSetClipboard = Win32::API::More->new('OLE32',
'int OleSetClipboard(LPVOID pDataObj)');
# my $ret = $OleSetClipboard->Call($pDataObj);
# pDataObj : IDataObject* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f OleFlushClipboard — クリップボードのデータをレンダリングして残し参照を解放する。
- f OleGetClipboard — OLEクリップボードのデータオブジェクトを取得する。
- f OleIsCurrentClipboard — 指定データオブジェクトが現在のクリップボード内容か判定する。