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

CIDLData_CreateFromIDArray

関数
PIDL配列からデータオブジェクトを生成する。
DLLSHELL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CIDLData_CreateFromIDArray(
    ITEMIDLIST* pidlFolder,
    DWORD cidl,
    ITEMIDLIST** apidl,   // optional
    IDataObject** ppdtobj
);

パラメーター

名前方向説明
pidlFolderITEMIDLIST*inapidl で指定される項目のルートを表す完全修飾された IDLIST。
cidlDWORDinapidl 配列内のエントリ数。
apidlITEMIDLIST**inoptionalpidlFolder を基準とした項目 ID の配列。通常、apidl は子 ID の配列であり、pidlFolder はそれらの項目の完全な PIDL です。ただし、pidlFolder は null PIDL(デスクトップの IDLIST)にすることもできます。その場合、apidl には完全修飾された ID リストを含めることができます。
ppdtobjIDataObject**outIDataObject を実装するオブジェクトへのポインターのアドレス。

戻り値の型: HRESULT

公式ドキュメント

CIDLData_CreateFromIDArray は変更されるか、利用できなくなる可能性があります。

戻り値

型: HRESULT

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

解説(Remarks)

この関数によって作成されるデータオブジェクトは、シェルのクリップボード形式識別子 CFSTR_SHELLIDLIST を提供します。このデータオブジェクトは、他のクリップボード形式を取得するための IDataObject::SetData 呼び出しもサポートします。

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

各言語での呼び出し定義

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

HRESULT CIDLData_CreateFromIDArray(
    ITEMIDLIST* pidlFolder,
    DWORD cidl,
    ITEMIDLIST** apidl,   // optional
    IDataObject** ppdtobj
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int CIDLData_CreateFromIDArray(
    IntPtr pidlFolder,   // ITEMIDLIST*
    uint cidl,   // DWORD
    IntPtr apidl,   // ITEMIDLIST** optional
    IntPtr ppdtobj   // IDataObject** out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function CIDLData_CreateFromIDArray(
    pidlFolder As IntPtr,   ' ITEMIDLIST*
    cidl As UInteger,   ' DWORD
    apidl As IntPtr,   ' ITEMIDLIST** optional
    ppdtobj As IntPtr   ' IDataObject** out
) As Integer
End Function
' pidlFolder : ITEMIDLIST*
' cidl : DWORD
' apidl : ITEMIDLIST** optional
' ppdtobj : IDataObject** out
Declare PtrSafe Function CIDLData_CreateFromIDArray Lib "shell32" ( _
    ByVal pidlFolder As LongPtr, _
    ByVal cidl As Long, _
    ByVal apidl As LongPtr, _
    ByVal ppdtobj As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CIDLData_CreateFromIDArray = ctypes.windll.shell32.CIDLData_CreateFromIDArray
CIDLData_CreateFromIDArray.restype = ctypes.c_int
CIDLData_CreateFromIDArray.argtypes = [
    ctypes.c_void_p,  # pidlFolder : ITEMIDLIST*
    wintypes.DWORD,  # cidl : DWORD
    ctypes.c_void_p,  # apidl : ITEMIDLIST** optional
    ctypes.c_void_p,  # ppdtobj : IDataObject** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
CIDLData_CreateFromIDArray = Fiddle::Function.new(
  lib['CIDLData_CreateFromIDArray'],
  [
    Fiddle::TYPE_VOIDP,  # pidlFolder : ITEMIDLIST*
    -Fiddle::TYPE_INT,  # cidl : DWORD
    Fiddle::TYPE_VOIDP,  # apidl : ITEMIDLIST** optional
    Fiddle::TYPE_VOIDP,  # ppdtobj : IDataObject** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn CIDLData_CreateFromIDArray(
        pidlFolder: *mut ITEMIDLIST,  // ITEMIDLIST*
        cidl: u32,  // DWORD
        apidl: *mut *mut ITEMIDLIST,  // ITEMIDLIST** optional
        ppdtobj: *mut *mut core::ffi::c_void  // IDataObject** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern int CIDLData_CreateFromIDArray(IntPtr pidlFolder, uint cidl, IntPtr apidl, IntPtr ppdtobj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_CIDLData_CreateFromIDArray' -Namespace Win32 -PassThru
# $api::CIDLData_CreateFromIDArray(pidlFolder, cidl, apidl, ppdtobj)
#uselib "SHELL32.dll"
#func global CIDLData_CreateFromIDArray "CIDLData_CreateFromIDArray" sptr, sptr, sptr, sptr
; CIDLData_CreateFromIDArray varptr(pidlFolder), cidl, varptr(apidl), ppdtobj   ; 戻り値は stat
; pidlFolder : ITEMIDLIST* -> "sptr"
; cidl : DWORD -> "sptr"
; apidl : ITEMIDLIST** optional -> "sptr"
; ppdtobj : IDataObject** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global CIDLData_CreateFromIDArray "CIDLData_CreateFromIDArray" var, int, var, sptr
; res = CIDLData_CreateFromIDArray(pidlFolder, cidl, apidl, ppdtobj)
; pidlFolder : ITEMIDLIST* -> "var"
; cidl : DWORD -> "int"
; apidl : ITEMIDLIST** optional -> "var"
; ppdtobj : IDataObject** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CIDLData_CreateFromIDArray(ITEMIDLIST* pidlFolder, DWORD cidl, ITEMIDLIST** apidl, IDataObject** ppdtobj)
#uselib "SHELL32.dll"
#cfunc global CIDLData_CreateFromIDArray "CIDLData_CreateFromIDArray" var, int, var, intptr
; res = CIDLData_CreateFromIDArray(pidlFolder, cidl, apidl, ppdtobj)
; pidlFolder : ITEMIDLIST* -> "var"
; cidl : DWORD -> "int"
; apidl : ITEMIDLIST** optional -> "var"
; ppdtobj : IDataObject** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procCIDLData_CreateFromIDArray = shell32.NewProc("CIDLData_CreateFromIDArray")
)

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

extern "shell32" fn CIDLData_CreateFromIDArray(
    pidlFolder: [*c]ITEMIDLIST, // ITEMIDLIST*
    cidl: u32, // DWORD
    apidl: [*c][*c]ITEMIDLIST, // ITEMIDLIST** optional
    ppdtobj: ?*anyopaque // IDataObject** out
) callconv(std.os.windows.WINAPI) i32;
proc CIDLData_CreateFromIDArray(
    pidlFolder: ptr ITEMIDLIST,  # ITEMIDLIST*
    cidl: uint32,  # DWORD
    apidl: ptr ITEMIDLIST,  # ITEMIDLIST** optional
    ppdtobj: pointer  # IDataObject** out
): int32 {.importc: "CIDLData_CreateFromIDArray", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int CIDLData_CreateFromIDArray(
    ITEMIDLIST* pidlFolder,   // ITEMIDLIST*
    uint cidl,   // DWORD
    ITEMIDLIST** apidl,   // ITEMIDLIST** optional
    void* ppdtobj   // IDataObject** out
);
ccall((:CIDLData_CreateFromIDArray, "SHELL32.dll"), stdcall, Int32,
      (Ptr{ITEMIDLIST}, UInt32, Ptr{ITEMIDLIST}, Ptr{Cvoid}),
      pidlFolder, cidl, apidl, ppdtobj)
# pidlFolder : ITEMIDLIST* -> Ptr{ITEMIDLIST}
# cidl : DWORD -> UInt32
# apidl : ITEMIDLIST** optional -> Ptr{ITEMIDLIST}
# ppdtobj : IDataObject** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CIDLData_CreateFromIDArray(
    void* pidlFolder,
    uint32_t cidl,
    void* apidl,
    void* ppdtobj);
]]
local shell32 = ffi.load("shell32")
-- shell32.CIDLData_CreateFromIDArray(pidlFolder, cidl, apidl, ppdtobj)
-- pidlFolder : ITEMIDLIST*
-- cidl : DWORD
-- apidl : ITEMIDLIST** optional
-- ppdtobj : IDataObject** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const CIDLData_CreateFromIDArray = lib.func('__stdcall', 'CIDLData_CreateFromIDArray', 'int32_t', ['void *', 'uint32_t', 'void *', 'void *']);
// CIDLData_CreateFromIDArray(pidlFolder, cidl, apidl, ppdtobj)
// pidlFolder : ITEMIDLIST* -> 'void *'
// cidl : DWORD -> 'uint32_t'
// apidl : ITEMIDLIST** optional -> 'void *'
// ppdtobj : IDataObject** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  CIDLData_CreateFromIDArray: { parameters: ["pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.CIDLData_CreateFromIDArray(pidlFolder, cidl, apidl, ppdtobj)
// pidlFolder : ITEMIDLIST* -> "pointer"
// cidl : DWORD -> "u32"
// apidl : ITEMIDLIST** optional -> "pointer"
// ppdtobj : IDataObject** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CIDLData_CreateFromIDArray(
    void* pidlFolder,
    uint32_t cidl,
    void* apidl,
    void* ppdtobj);
C, "SHELL32.dll");
// $ffi->CIDLData_CreateFromIDArray(pidlFolder, cidl, apidl, ppdtobj);
// pidlFolder : ITEMIDLIST*
// cidl : DWORD
// apidl : ITEMIDLIST** optional
// ppdtobj : 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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    int CIDLData_CreateFromIDArray(
        Pointer pidlFolder,   // ITEMIDLIST*
        int cidl,   // DWORD
        Pointer apidl,   // ITEMIDLIST** optional
        Pointer ppdtobj   // IDataObject** out
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun CIDLData_CreateFromIDArray = CIDLData_CreateFromIDArray(
    pidlFolder : ITEMIDLIST*,   # ITEMIDLIST*
    cidl : UInt32,   # DWORD
    apidl : ITEMIDLIST**,   # ITEMIDLIST** optional
    ppdtobj : 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 CIDLData_CreateFromIDArrayNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef CIDLData_CreateFromIDArrayDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final CIDLData_CreateFromIDArray = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<CIDLData_CreateFromIDArrayNative, CIDLData_CreateFromIDArrayDart>('CIDLData_CreateFromIDArray');
// pidlFolder : ITEMIDLIST* -> Pointer<Void>
// cidl : DWORD -> Uint32
// apidl : ITEMIDLIST** optional -> Pointer<Void>
// ppdtobj : IDataObject** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CIDLData_CreateFromIDArray(
  pidlFolder: Pointer;   // ITEMIDLIST*
  cidl: DWORD;   // DWORD
  apidl: Pointer;   // ITEMIDLIST** optional
  ppdtobj: Pointer   // IDataObject** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'CIDLData_CreateFromIDArray';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CIDLData_CreateFromIDArray"
  c_CIDLData_CreateFromIDArray :: Ptr () -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- pidlFolder : ITEMIDLIST* -> Ptr ()
-- cidl : DWORD -> Word32
-- apidl : ITEMIDLIST** optional -> Ptr ()
-- ppdtobj : IDataObject** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cidldata_createfromidarray =
  foreign "CIDLData_CreateFromIDArray"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pidlFolder : ITEMIDLIST* -> (ptr void) *)
(* cidl : DWORD -> uint32_t *)
(* apidl : ITEMIDLIST** optional -> (ptr void) *)
(* ppdtobj : IDataObject** 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 ("CIDLData_CreateFromIDArray" cidldata-create-from-idarray :convention :stdcall) :int32
  (pidl-folder :pointer)   ; ITEMIDLIST*
  (cidl :uint32)   ; DWORD
  (apidl :pointer)   ; ITEMIDLIST** optional
  (ppdtobj :pointer))   ; IDataObject** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CIDLData_CreateFromIDArray = Win32::API::More->new('SHELL32',
    'int CIDLData_CreateFromIDArray(LPVOID pidlFolder, DWORD cidl, LPVOID apidl, LPVOID ppdtobj)');
# my $ret = $CIDLData_CreateFromIDArray->Call($pidlFolder, $cidl, $apidl, $ppdtobj);
# pidlFolder : ITEMIDLIST* -> LPVOID
# cidl : DWORD -> DWORD
# apidl : ITEMIDLIST** optional -> LPVOID
# ppdtobj : IDataObject** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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