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

OleGetClipboard

関数
OLEクリップボードのデータオブジェクトを取得する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleGetClipboard(
    IDataObject** ppDataObj
);

パラメーター

名前方向説明
ppDataObjIDataObject**outクリップボードデータオブジェクトへのインターフェイスポインターを受け取る IDataObject ポインター変数のアドレスです。

戻り値の型: HRESULT

公式ドキュメント

クリップボードの内容にアクセスするために使用できるデータオブジェクトを取得します。

戻り値

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

戻り値 説明
CLIPBRD_E_CANT_OPEN
OleFlushClipboard 内で使用される OpenClipboard 関数が失敗しました。
CLIPBRD_E_CANT_CLOSE
OleFlushClipboard 内で使用される CloseClipboard 関数が失敗しました。

解説(Remarks)

注意 クリップボードのデータは信頼できません。アプリケーションで使用する前に、データを慎重に解析してください。
クリップボードからデータを受け取ることができるアプリケーションを作成している場合は、OleGetClipboard 関数を呼び出して、クリップボードの内容を取得するために使用できる IDataObject インターフェイスへのポインターを取得します。

OleGetClipboard は次の3つのケースを処理します。

最初のケースでは、OleGetClipboard が返すクリップボードデータオブジェクトは、必要に応じて呼び出しをクリップボードに配置された元のデータオブジェクトへ転送する場合があり、その結果 RPC 呼び出しを行う可能性があります。

2番目のケースでは、OLE が既定のデータオブジェクトを作成してユーザーに返します。クリップボード上のデータは OleSetClipboard の呼び出しに由来するため、OLE が提供するデータオブジェクトには、クリップボード上のデータの種類に関するより正確な情報が含まれます。特に、データが提供された元のメディウム (TYMED) が判明しています。したがって、データソースアプリケーションが特定のクリップボード形式(たとえば cfFOO)をストレージオブジェクト上で提供し、OleFlushClipboard 関数を呼び出すと、ストレージオブジェクトはメモリにコピーされ、hglobal メモリハンドルがクリップボードに配置されます。その後、OleGetClipboard 関数が既定のデータオブジェクトを作成すると、クリップボードの hglobal は再び IStorage オブジェクトになります。さらに、FORMATETC 列挙子と IDataObject::QueryGetData メソッドはすべて、元のクリップボード形式 (cfFOO) が再び TYMED_ISTORAGE で利用可能であることを正しく示します。

3番目のケースでは、OLE は依然として既定のデータオブジェクトを作成しますが、クリップボード形式内のデータに関する特別な情報はありません(特にアプリケーション定義のクリップボード形式の場合)。したがって、hGlobal ベースのストレージメディウムが SetClipboardData 関数の呼び出しによってクリップボードに直接配置された場合、FORMATETC 列挙子と IDataObject::QueryGetData メソッドは、データがストレージメディウムで利用可能であることを示しません。ただし、TYMED_ISTORAGE に対する IDataObject::GetData メソッドの呼び出しは成功します。これらの制限のため、OLE 対応アプリケーションは OLE クリップボード関数を使用してクリップボードと対話することを強くお勧めします。

OleGetClipboard 関数によって作成されるクリップボードデータオブジェクトは、かなり広範な IDataObject の実装を備えています。OLE が提供するデータオブジェクトは、OLE 1 のクリップボード形式データを OLE 2 の呼び出し側が期待する表現に変換できます。また、あらゆる構造化データは任意の構造化メディウムまたはフラットメディウムで利用でき、あらゆるフラットデータは任意のフラットメディウムで利用できます。ただし、GDI オブジェクト(メタファイルやビットマップなど)は、それぞれ対応するメディウムでのみ利用できます。

FORMATETC 列挙子で使用される FORMATETC 構造体の tymed メンバーには、サポートされるメディウムの和集合が含まれることに注意してください。特定の情報(たとえば CF_TEXTTYMED_HGLOBAL で利用可能かどうか)を調べるアプリケーションは、この値をチェックする際に適切なビットマスク処理を行う必要があります。

OleGetClipboard 関数を呼び出す場合は、返された IDataObject をごく短時間だけ保持するようにしてください。これは、それを提供したアプリケーションのリソースを消費します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

OleGetClipboard = ctypes.windll.ole32.OleGetClipboard
OleGetClipboard.restype = ctypes.c_int
OleGetClipboard.argtypes = [
    ctypes.c_void_p,  # ppDataObj : IDataObject** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleGetClipboard = ole32.NewProc("OleGetClipboard")
)

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

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

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

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

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

(cffi:defcfun ("OleGetClipboard" ole-get-clipboard :convention :stdcall) :int32
  (pp-data-obj :pointer))   ; IDataObject** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleGetClipboard = Win32::API::More->new('OLE32',
    'int OleGetClipboard(LPVOID ppDataObj)');
# my $ret = $OleGetClipboard->Call($ppDataObj);
# ppDataObj : IDataObject** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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