ホーム › UI.Shell › SHCreateShellItemArray

SHCreateShellItemArray

関数

複数PIDLからシェルアイテム配列を作成する。

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

シグネチャ

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

HRESULT SHCreateShellItemArray(
    ITEMIDLIST* pidlParent,   // optional
    IShellFolder* psf,   // optional
    DWORD cidl,
    ITEMIDLIST** ppidl,   // optional
    IShellItemArray** ppsiItemArray
);

パラメーター

名前	型	方向	説明
pidlParent	ITEMIDLIST*	inoptional	ppidl で指定された項目の親フォルダーの ID リストです。psf が指定されている場合、このパラメーターは NULL にできます。この pidlParent が指定されていない場合は、IPersistFolder2 を使用して psf パラメーターから計算されます。
psf	IShellFolder*	inoptional	ppidl で指定された子項目の親となるシェルデータソースオブジェクトです。pidlParent が指定されている場合、このパラメーターは NULL にできます。
cidl	DWORD	in	ppidl で指定された配列の要素数です。
ppidl	ITEMIDLIST**	inoptional	配列の作成対象となる子項目 ID のリストです。この値は NULL にできます。
ppsiItemArray	IShellItemArray**	out	この関数が返るときに、IShellItemArray インターフェイスポインターのアドレスが格納されます。

戻り値の型: HRESULT

公式ドキュメント

シェル項目配列オブジェクトを作成します。

戻り値

型: HRESULT

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

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

各言語での呼び出し定義

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

HRESULT SHCreateShellItemArray(
    ITEMIDLIST* pidlParent,   // optional
    IShellFolder* psf,   // optional
    DWORD cidl,
    ITEMIDLIST** ppidl,   // optional
    IShellItemArray** ppsiItemArray
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHCreateShellItemArray(
    IntPtr pidlParent,   // ITEMIDLIST* optional
    IntPtr psf,   // IShellFolder* optional
    uint cidl,   // DWORD
    IntPtr ppidl,   // ITEMIDLIST** optional
    IntPtr ppsiItemArray   // IShellItemArray** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHCreateShellItemArray(
    pidlParent As IntPtr,   ' ITEMIDLIST* optional
    psf As IntPtr,   ' IShellFolder* optional
    cidl As UInteger,   ' DWORD
    ppidl As IntPtr,   ' ITEMIDLIST** optional
    ppsiItemArray As IntPtr   ' IShellItemArray** out
) As Integer
End Function

' pidlParent : ITEMIDLIST* optional
' psf : IShellFolder* optional
' cidl : DWORD
' ppidl : ITEMIDLIST** optional
' ppsiItemArray : IShellItemArray** out
Declare PtrSafe Function SHCreateShellItemArray Lib "shell32" ( _
    ByVal pidlParent As LongPtr, _
    ByVal psf As LongPtr, _
    ByVal cidl As Long, _
    ByVal ppidl As LongPtr, _
    ByVal ppsiItemArray As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHCreateShellItemArray = ctypes.windll.shell32.SHCreateShellItemArray
SHCreateShellItemArray.restype = ctypes.c_int
SHCreateShellItemArray.argtypes = [
    ctypes.c_void_p,  # pidlParent : ITEMIDLIST* optional
    ctypes.c_void_p,  # psf : IShellFolder* optional
    wintypes.DWORD,  # cidl : DWORD
    ctypes.c_void_p,  # ppidl : ITEMIDLIST** optional
    ctypes.c_void_p,  # ppsiItemArray : IShellItemArray** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCreateShellItemArray = Fiddle::Function.new(
  lib['SHCreateShellItemArray'],
  [
    Fiddle::TYPE_VOIDP,  # pidlParent : ITEMIDLIST* optional
    Fiddle::TYPE_VOIDP,  # psf : IShellFolder* optional
    -Fiddle::TYPE_INT,  # cidl : DWORD
    Fiddle::TYPE_VOIDP,  # ppidl : ITEMIDLIST** optional
    Fiddle::TYPE_VOIDP,  # ppsiItemArray : IShellItemArray** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHCreateShellItemArray(
        pidlParent: *mut ITEMIDLIST,  // ITEMIDLIST* optional
        psf: *mut core::ffi::c_void,  // IShellFolder* optional
        cidl: u32,  // DWORD
        ppidl: *mut *mut ITEMIDLIST,  // ITEMIDLIST** optional
        ppsiItemArray: *mut *mut core::ffi::c_void  // IShellItemArray** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHCreateShellItemArray(IntPtr pidlParent, IntPtr psf, uint cidl, IntPtr ppidl, IntPtr ppsiItemArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCreateShellItemArray' -Namespace Win32 -PassThru
# $api::SHCreateShellItemArray(pidlParent, psf, cidl, ppidl, ppsiItemArray)

#uselib "SHELL32.dll"
#func global SHCreateShellItemArray "SHCreateShellItemArray" sptr, sptr, sptr, sptr, sptr
; SHCreateShellItemArray varptr(pidlParent), psf, cidl, varptr(ppidl), ppsiItemArray   ; 戻り値は stat
; pidlParent : ITEMIDLIST* optional -> "sptr"
; psf : IShellFolder* optional -> "sptr"
; cidl : DWORD -> "sptr"
; ppidl : ITEMIDLIST** optional -> "sptr"
; ppsiItemArray : IShellItemArray** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHCreateShellItemArray "SHCreateShellItemArray" var, sptr, int, var, sptr
; res = SHCreateShellItemArray(pidlParent, psf, cidl, ppidl, ppsiItemArray)
; pidlParent : ITEMIDLIST* optional -> "var"
; psf : IShellFolder* optional -> "sptr"
; cidl : DWORD -> "int"
; ppidl : ITEMIDLIST** optional -> "var"
; ppsiItemArray : IShellItemArray** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHCreateShellItemArray "SHCreateShellItemArray" sptr, sptr, int, sptr, sptr
; res = SHCreateShellItemArray(varptr(pidlParent), psf, cidl, varptr(ppidl), ppsiItemArray)
; pidlParent : ITEMIDLIST* optional -> "sptr"
; psf : IShellFolder* optional -> "sptr"
; cidl : DWORD -> "int"
; ppidl : ITEMIDLIST** optional -> "sptr"
; ppsiItemArray : IShellItemArray** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。