ホーム › UI.Shell › SHCreateDataObject

SHCreateDataObject

関数

シェルアイテムからIDataObjectを生成する。

DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT SHCreateDataObject(
    ITEMIDLIST* pidlFolder,   // optional
    DWORD cidl,
    ITEMIDLIST** apidl,   // optional
    IDataObject* pdtInner,   // optional
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
pidlFolder	ITEMIDLIST*	inoptional	データオブジェクトを格納する親フォルダーの ITEMIDLIST (PIDL) へのポインター。
cidl	DWORD	in	apidl パラメーターで指定されるファイルオブジェクトまたはサブフォルダーの数。
apidl	ITEMIDLIST**	inoptional	定数 ITEMIDLIST 構造体へのポインターの配列。各ポインターは、親フォルダーを基準としてファイルオブジェクトまたはサブフォルダーを一意に識別します。各アイテム識別子リストは、ちょうど 1 つの SHITEMID 構造体と、それに続く終端のゼロを含んでいる必要があります。
pdtInner	IDataObject*	inoptional	IDataObject インターフェイスへのポインター。このパラメーターは NULL にできます。pdtInner を指定するのは、作成されるデータオブジェクトが、作成時に割り当てられる既定の形式以外の FORMATETC クリップボード形式をサポートする必要がある場合のみです。あるいは、IDataObject::SetData メソッドを呼び出し、パラメーター pFormatetc に渡す FORMATETC 構造体で形式を指定することで、既定以外のクリップボード形式を使用して作成済みのデータオブジェクトを設定するサポートを提供します。
riid	GUID*	in	ppv を通じて取得するインターフェイスの IID への参照。これは IID_IDataObject である必要があります。
ppv	void**	out	このメソッドが正常に終了すると、riid で要求された IDataObject インターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

親フォルダー内にデータオブジェクトを作成します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

この関数は通常、IShellFolder::GetUIObjectOf メソッドを実装する際に呼び出されます。インターフェイス ID IID_IDataObject のインターフェイスポインターが (パラメーター riid を使用して) 要求された場合、実装者はその応答として、SHCreateDataObject で作成したオブジェクト上のインターフェイスポインターを返すことができます。

この関数は CFSTR_SHELLIDLIST (HIDA とも呼ばれます) クリップボード形式をサポートしており、また IDataObject::SetData を通じて任意のクリップボード形式に対する汎用的なサポートも備えています。クリップボード形式の詳細については、「Shell Clipboard Formats」を参照してください。

新しいデータオブジェクトは、データが特定の形式でクリップボードに格納されるドラッグアンドドロップなどの操作で使用することを想定しています。

riid パラメーターと ppv パラメーターをまとめるには、Objbase.h で定義されている IID_PPV_ARGS マクロを使用することをお勧めします。このマクロは ppv の値が指すインターフェイスに基づいて正しい IID を提供するため、riid のコーディングミスによって予期しない結果を招く可能性を排除できます。

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

各言語での呼び出し定義

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

HRESULT SHCreateDataObject(
    ITEMIDLIST* pidlFolder,   // optional
    DWORD cidl,
    ITEMIDLIST** apidl,   // optional
    IDataObject* pdtInner,   // optional
    const GUID* riid,
    void** ppv
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHCreateDataObject(
    IntPtr pidlFolder,   // ITEMIDLIST* optional
    uint cidl,   // DWORD
    IntPtr apidl,   // ITEMIDLIST** optional
    IntPtr pdtInner,   // IDataObject* optional
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHCreateDataObject(
    pidlFolder As IntPtr,   ' ITEMIDLIST* optional
    cidl As UInteger,   ' DWORD
    apidl As IntPtr,   ' ITEMIDLIST** optional
    pdtInner As IntPtr,   ' IDataObject* optional
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' pidlFolder : ITEMIDLIST* optional
' cidl : DWORD
' apidl : ITEMIDLIST** optional
' pdtInner : IDataObject* optional
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function SHCreateDataObject Lib "shell32" ( _
    ByVal pidlFolder As LongPtr, _
    ByVal cidl As Long, _
    ByVal apidl As LongPtr, _
    ByVal pdtInner As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHCreateDataObject = ctypes.windll.shell32.SHCreateDataObject
SHCreateDataObject.restype = ctypes.c_int
SHCreateDataObject.argtypes = [
    ctypes.c_void_p,  # pidlFolder : ITEMIDLIST* optional
    wintypes.DWORD,  # cidl : DWORD
    ctypes.c_void_p,  # apidl : ITEMIDLIST** optional
    ctypes.c_void_p,  # pdtInner : IDataObject* optional
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCreateDataObject = Fiddle::Function.new(
  lib['SHCreateDataObject'],
  [
    Fiddle::TYPE_VOIDP,  # pidlFolder : ITEMIDLIST* optional
    -Fiddle::TYPE_INT,  # cidl : DWORD
    Fiddle::TYPE_VOIDP,  # apidl : ITEMIDLIST** optional
    Fiddle::TYPE_VOIDP,  # pdtInner : IDataObject* optional
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHCreateDataObject(
        pidlFolder: *mut ITEMIDLIST,  // ITEMIDLIST* optional
        cidl: u32,  // DWORD
        apidl: *mut *mut ITEMIDLIST,  // ITEMIDLIST** optional
        pdtInner: *mut core::ffi::c_void,  // IDataObject* optional
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHCreateDataObject(IntPtr pidlFolder, uint cidl, IntPtr apidl, IntPtr pdtInner, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCreateDataObject' -Namespace Win32 -PassThru
# $api::SHCreateDataObject(pidlFolder, cidl, apidl, pdtInner, riid, ppv)

#uselib "SHELL32.dll"
#func global SHCreateDataObject "SHCreateDataObject" sptr, sptr, sptr, sptr, sptr, sptr
; SHCreateDataObject varptr(pidlFolder), cidl, varptr(apidl), pdtInner, varptr(riid), ppv   ; 戻り値は stat
; pidlFolder : ITEMIDLIST* optional -> "sptr"
; cidl : DWORD -> "sptr"
; apidl : ITEMIDLIST** optional -> "sptr"
; pdtInner : IDataObject* optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHCreateDataObject "SHCreateDataObject" var, int, var, sptr, var, sptr
; res = SHCreateDataObject(pidlFolder, cidl, apidl, pdtInner, riid, ppv)
; pidlFolder : ITEMIDLIST* optional -> "var"
; cidl : DWORD -> "int"
; apidl : ITEMIDLIST** optional -> "var"
; pdtInner : IDataObject* optional -> "sptr"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHCreateDataObject "SHCreateDataObject" sptr, int, sptr, sptr, sptr, sptr
; res = SHCreateDataObject(varptr(pidlFolder), cidl, varptr(apidl), pdtInner, varptr(riid), ppv)
; pidlFolder : ITEMIDLIST* optional -> "sptr"
; cidl : DWORD -> "int"
; apidl : ITEMIDLIST** optional -> "sptr"
; pdtInner : IDataObject* optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。