ホーム › UI.Shell › SHCreateShellItemArrayFromIDLists

SHCreateShellItemArrayFromIDLists

関数

アイテムIDリスト群からシェルアイテム配列を作成する。

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

シグネチャ

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

HRESULT SHCreateShellItemArrayFromIDLists(
    DWORD cidl,
    ITEMIDLIST** rgpidl,
    IShellItemArray** ppsiItemArray
);

パラメーター

名前	型	方向	説明
cidl	DWORD	in	配列内の要素数です。
rgpidl	ITEMIDLIST**	in	ITEMIDLIST 構造体への cidl 個の定数ポインターのリストです。
ppsiItemArray	IShellItemArray**	out	この関数が返るときに、IShellItemArray インターフェイスへのポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

ITEMIDLIST 構造体のリストから Shell アイテム配列オブジェクトを作成します。

戻り値

型: 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 SHCreateShellItemArrayFromIDLists(
    DWORD cidl,
    ITEMIDLIST** rgpidl,
    IShellItemArray** ppsiItemArray
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHCreateShellItemArrayFromIDLists(
    uint cidl,   // DWORD
    IntPtr rgpidl,   // ITEMIDLIST**
    IntPtr ppsiItemArray   // IShellItemArray** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHCreateShellItemArrayFromIDLists(
    cidl As UInteger,   ' DWORD
    rgpidl As IntPtr,   ' ITEMIDLIST**
    ppsiItemArray As IntPtr   ' IShellItemArray** out
) As Integer
End Function

' cidl : DWORD
' rgpidl : ITEMIDLIST**
' ppsiItemArray : IShellItemArray** out
Declare PtrSafe Function SHCreateShellItemArrayFromIDLists Lib "shell32" ( _
    ByVal cidl As Long, _
    ByVal rgpidl 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

SHCreateShellItemArrayFromIDLists = ctypes.windll.shell32.SHCreateShellItemArrayFromIDLists
SHCreateShellItemArrayFromIDLists.restype = ctypes.c_int
SHCreateShellItemArrayFromIDLists.argtypes = [
    wintypes.DWORD,  # cidl : DWORD
    ctypes.c_void_p,  # rgpidl : ITEMIDLIST**
    ctypes.c_void_p,  # ppsiItemArray : IShellItemArray** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCreateShellItemArrayFromIDLists = Fiddle::Function.new(
  lib['SHCreateShellItemArrayFromIDLists'],
  [
    -Fiddle::TYPE_INT,  # cidl : DWORD
    Fiddle::TYPE_VOIDP,  # rgpidl : ITEMIDLIST**
    Fiddle::TYPE_VOIDP,  # ppsiItemArray : IShellItemArray** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHCreateShellItemArrayFromIDLists(
        cidl: u32,  // DWORD
        rgpidl: *mut *mut ITEMIDLIST,  // ITEMIDLIST**
        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 SHCreateShellItemArrayFromIDLists(uint cidl, IntPtr rgpidl, IntPtr ppsiItemArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCreateShellItemArrayFromIDLists' -Namespace Win32 -PassThru
# $api::SHCreateShellItemArrayFromIDLists(cidl, rgpidl, ppsiItemArray)

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

出力引数:

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