ホーム › System.Ole › OleGetClipboardWithEnterpriseInfo

OleGetClipboardWithEnterpriseInfo

関数

企業情報付きでクリップボードのデータオブジェクトを取得する。

DLLOLE32.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT OleGetClipboardWithEnterpriseInfo(
    IDataObject** dataObject,
    LPWSTR* dataEnterpriseId,
    LPWSTR* sourceDescription,
    LPWSTR* targetDescription,
    LPWSTR* dataDescription
);

パラメーター

名前	型	方向	説明
dataObject	IDataObject**	out	クリップボードデータオブジェクトへのインターフェイスポインターを受け取る IDataObject ポインター変数のアドレスです。
dataEnterpriseId	LPWSTR*	out	クリップボードデータを設定したアプリケーションのエンタープライズ ID です。データが個人用の場合、これは空の文字列になります。
sourceDescription	LPWSTR*	out	クリップボードを設定したアプリケーションの説明です。
targetDescription	LPWSTR*	out	監査に使用される、呼び出し元アプリケーションの説明です。
dataDescription	LPWSTR*	out	監査に使用される、データオブジェクトの説明です。

戻り値の型: HRESULT

公式ドキュメント

Windows Information Protection に対応したアプリケーションが、OLE クリップボードから IDataObject を取得する際に、そのデータおよびソースアプリケーションに関する Windows Information Protection 情報を併せて取得できるようにします。

戻り値

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

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

解説(Remarks)

注意クリップボードデータは信頼できません。アプリケーションで使用する前に、データを慎重に解析してください。

クリップボードからデータを受け取れるアプリケーションを作成する場合は、OleGetClipboardWithEnterpriseInfo 関数を呼び出して IDataObject インターフェイスへのポインターを取得し、それを使用してクリップボードの内容を取得します。

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

OleSetClipboard 関数でクリップボードにデータを配置したアプリケーションがまだ実行中である場合。
OleSetClipboard 関数でクリップボードにデータを配置したアプリケーションが、その後 OleFlushClipboard 関数を呼び出した場合。
OLE 以外のアプリケーションのデータがクリップボードにある場合。

1 つ目のケースでは、OleGetClipboardWithEnterpriseInfo が返すクリップボードデータオブジェクトは、必要に応じて、クリップボードに配置された元のデータオブジェクトへ呼び出しを転送することがあり、その結果 RPC 呼び出しが発生する可能性があります。

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

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

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

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

OleGetClipboardWithEnterpriseInfo 関数を呼び出す場合は、返された 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 OleGetClipboardWithEnterpriseInfo(
    IDataObject** dataObject,
    LPWSTR* dataEnterpriseId,
    LPWSTR* sourceDescription,
    LPWSTR* targetDescription,
    LPWSTR* dataDescription
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleGetClipboardWithEnterpriseInfo(
    IntPtr dataObject,   // IDataObject** out
    IntPtr dataEnterpriseId,   // LPWSTR* out
    IntPtr sourceDescription,   // LPWSTR* out
    IntPtr targetDescription,   // LPWSTR* out
    IntPtr dataDescription   // LPWSTR* out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleGetClipboardWithEnterpriseInfo(
    dataObject As IntPtr,   ' IDataObject** out
    dataEnterpriseId As IntPtr,   ' LPWSTR* out
    sourceDescription As IntPtr,   ' LPWSTR* out
    targetDescription As IntPtr,   ' LPWSTR* out
    dataDescription As IntPtr   ' LPWSTR* out
) As Integer
End Function

' dataObject : IDataObject** out
' dataEnterpriseId : LPWSTR* out
' sourceDescription : LPWSTR* out
' targetDescription : LPWSTR* out
' dataDescription : LPWSTR* out
Declare PtrSafe Function OleGetClipboardWithEnterpriseInfo Lib "ole32" ( _
    ByVal dataObject As LongPtr, _
    ByVal dataEnterpriseId As LongPtr, _
    ByVal sourceDescription As LongPtr, _
    ByVal targetDescription As LongPtr, _
    ByVal dataDescription As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OleGetClipboardWithEnterpriseInfo = ctypes.windll.ole32.OleGetClipboardWithEnterpriseInfo
OleGetClipboardWithEnterpriseInfo.restype = ctypes.c_int
OleGetClipboardWithEnterpriseInfo.argtypes = [
    ctypes.c_void_p,  # dataObject : IDataObject** out
    ctypes.c_void_p,  # dataEnterpriseId : LPWSTR* out
    ctypes.c_void_p,  # sourceDescription : LPWSTR* out
    ctypes.c_void_p,  # targetDescription : LPWSTR* out
    ctypes.c_void_p,  # dataDescription : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleGetClipboardWithEnterpriseInfo = Fiddle::Function.new(
  lib['OleGetClipboardWithEnterpriseInfo'],
  [
    Fiddle::TYPE_VOIDP,  # dataObject : IDataObject** out
    Fiddle::TYPE_VOIDP,  # dataEnterpriseId : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # sourceDescription : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # targetDescription : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # dataDescription : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn OleGetClipboardWithEnterpriseInfo(
        dataObject: *mut *mut core::ffi::c_void,  // IDataObject** out
        dataEnterpriseId: *mut *mut u16,  // LPWSTR* out
        sourceDescription: *mut *mut u16,  // LPWSTR* out
        targetDescription: *mut *mut u16,  // LPWSTR* out
        dataDescription: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleGetClipboardWithEnterpriseInfo(IntPtr dataObject, IntPtr dataEnterpriseId, IntPtr sourceDescription, IntPtr targetDescription, IntPtr dataDescription);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleGetClipboardWithEnterpriseInfo' -Namespace Win32 -PassThru
# $api::OleGetClipboardWithEnterpriseInfo(dataObject, dataEnterpriseId, sourceDescription, targetDescription, dataDescription)

#uselib "OLE32.dll"
#func global OleGetClipboardWithEnterpriseInfo "OleGetClipboardWithEnterpriseInfo" sptr, sptr, sptr, sptr, sptr
; OleGetClipboardWithEnterpriseInfo dataObject, varptr(dataEnterpriseId), varptr(sourceDescription), varptr(targetDescription), varptr(dataDescription)   ; 戻り値は stat
; dataObject : IDataObject** out -> "sptr"
; dataEnterpriseId : LPWSTR* out -> "sptr"
; sourceDescription : LPWSTR* out -> "sptr"
; targetDescription : LPWSTR* out -> "sptr"
; dataDescription : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global OleGetClipboardWithEnterpriseInfo "OleGetClipboardWithEnterpriseInfo" sptr, var, var, var, var
; res = OleGetClipboardWithEnterpriseInfo(dataObject, dataEnterpriseId, sourceDescription, targetDescription, dataDescription)
; dataObject : IDataObject** out -> "sptr"
; dataEnterpriseId : LPWSTR* out -> "var"
; sourceDescription : LPWSTR* out -> "var"
; targetDescription : LPWSTR* out -> "var"
; dataDescription : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global OleGetClipboardWithEnterpriseInfo "OleGetClipboardWithEnterpriseInfo" sptr, sptr, sptr, sptr, sptr
; res = OleGetClipboardWithEnterpriseInfo(dataObject, varptr(dataEnterpriseId), varptr(sourceDescription), varptr(targetDescription), varptr(dataDescription))
; dataObject : IDataObject** out -> "sptr"
; dataEnterpriseId : LPWSTR* out -> "sptr"
; sourceDescription : LPWSTR* out -> "sptr"
; targetDescription : LPWSTR* out -> "sptr"
; dataDescription : LPWSTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。