Win32 API 日本語リファレンス
ホームUI.Shell › SHCreateShellItemArrayFromDataObject

SHCreateShellItemArrayFromDataObject

関数
データオブジェクトからシェルアイテム配列を作成する。
DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT SHCreateShellItemArrayFromDataObject(
    IDataObject* pdo,
    const GUID* riid,
    void** ppv
);

パラメーター

名前方向説明
pdoIDataObject*inIDataObject インターフェイスへのポインター。
riidGUID*in要求するインターフェイス ID への参照。
ppvvoid**outこのメソッドが返るとき、riid で要求されたインターフェイスポインターが格納されます。通常は IShellItemArray です。

戻り値の型: HRESULT

公式ドキュメント

データオブジェクトからシェルアイテム配列オブジェクトを作成します。

戻り値

型: HRESULT

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

解説(Remarks)

この関数は、IShellExtInit を実装し、IShellExtInit::Initialize メソッドにデータオブジェクトが渡されるシェル拡張機能 (たとえばコンテキストメニューハンドラー) にとって有用です。

この API を使用すると、データオブジェクトをハンドラーが利用できるシェルアイテムに変換できます。ハンドラーでは、CF_HDROPCFSTR_SHELLIDLIST (HIDA とも呼ばれます) などのクリップボード形式ではなく、シェルアイテム配列を使用することをお勧めします。コードがシンプルになり、パフォーマンスを向上できる場合があるためです。

生成されるシェルアイテム配列は、ソースとなるデータオブジェクトへの参照を保持します。そのため、そのデータオブジェクトはシェルアイテム配列の有効期間中、有効なまま保たれる必要があります。特に、IDropTarget メソッドに渡されたデータオブジェクトは、ドロップ操作の完了後は有効ではなくなります。

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

各言語での呼び出し定義

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

HRESULT SHCreateShellItemArrayFromDataObject(
    IDataObject* pdo,
    const GUID* riid,
    void** ppv
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHCreateShellItemArrayFromDataObject(
    IntPtr pdo,   // IDataObject*
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHCreateShellItemArrayFromDataObject(
    pdo As IntPtr,   ' IDataObject*
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function
' pdo : IDataObject*
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function SHCreateShellItemArrayFromDataObject Lib "shell32" ( _
    ByVal pdo 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

SHCreateShellItemArrayFromDataObject = ctypes.windll.shell32.SHCreateShellItemArrayFromDataObject
SHCreateShellItemArrayFromDataObject.restype = ctypes.c_int
SHCreateShellItemArrayFromDataObject.argtypes = [
    ctypes.c_void_p,  # pdo : IDataObject*
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCreateShellItemArrayFromDataObject = Fiddle::Function.new(
  lib['SHCreateShellItemArrayFromDataObject'],
  [
    Fiddle::TYPE_VOIDP,  # pdo : IDataObject*
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHCreateShellItemArrayFromDataObject(
        pdo: *mut core::ffi::c_void,  // IDataObject*
        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 SHCreateShellItemArrayFromDataObject(IntPtr pdo, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCreateShellItemArrayFromDataObject' -Namespace Win32 -PassThru
# $api::SHCreateShellItemArrayFromDataObject(pdo, riid, ppv)
#uselib "SHELL32.dll"
#func global SHCreateShellItemArrayFromDataObject "SHCreateShellItemArrayFromDataObject" sptr, sptr, sptr
; SHCreateShellItemArrayFromDataObject pdo, varptr(riid), ppv   ; 戻り値は stat
; pdo : IDataObject* -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHCreateShellItemArrayFromDataObject "SHCreateShellItemArrayFromDataObject" sptr, var, sptr
; res = SHCreateShellItemArrayFromDataObject(pdo, riid, ppv)
; pdo : IDataObject* -> "sptr"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHCreateShellItemArrayFromDataObject(IDataObject* pdo, GUID* riid, void** ppv)
#uselib "SHELL32.dll"
#cfunc global SHCreateShellItemArrayFromDataObject "SHCreateShellItemArrayFromDataObject" intptr, var, intptr
; res = SHCreateShellItemArrayFromDataObject(pdo, riid, ppv)
; pdo : IDataObject* -> "intptr"
; riid : GUID* -> "var"
; ppv : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHCreateShellItemArrayFromDataObject = shell32.NewProc("SHCreateShellItemArrayFromDataObject")
)

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

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

typedef SHCreateShellItemArrayFromDataObjectNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef SHCreateShellItemArrayFromDataObjectDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final SHCreateShellItemArrayFromDataObject = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHCreateShellItemArrayFromDataObjectNative, SHCreateShellItemArrayFromDataObjectDart>('SHCreateShellItemArrayFromDataObject');
// pdo : IDataObject* -> Pointer<Void>
// riid : GUID* -> Pointer<Void>
// ppv : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHCreateShellItemArrayFromDataObject(
  pdo: Pointer;   // IDataObject*
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHCreateShellItemArrayFromDataObject';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shcreateshellitemarrayfromdataobject =
  foreign "SHCreateShellItemArrayFromDataObject"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pdo : IDataObject* -> (ptr void) *)
(* riid : GUID* -> (ptr void) *)
(* ppv : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHCreateShellItemArrayFromDataObject" shcreate-shell-item-array-from-data-object :convention :stdcall) :int32
  (pdo :pointer)   ; IDataObject*
  (riid :pointer)   ; GUID*
  (ppv :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHCreateShellItemArrayFromDataObject = Win32::API::More->new('SHELL32',
    'int SHCreateShellItemArrayFromDataObject(LPVOID pdo, LPVOID riid, LPVOID ppv)');
# my $ret = $SHCreateShellItemArrayFromDataObject->Call($pdo, $riid, $ppv);
# pdo : IDataObject* -> LPVOID
# riid : GUID* -> LPVOID
# ppv : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型