ホーム › UI.Shell › SHOpenFolderAndSelectItems

SHOpenFolderAndSelectItems

関数

フォルダーを開いて指定アイテムを選択状態にする。

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

シグネチャ

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

HRESULT SHOpenFolderAndSelectItems(
    ITEMIDLIST* pidlFolder,
    DWORD cidl,
    ITEMIDLIST** apidl,   // optional
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
pidlFolder	ITEMIDLIST*	in	フォルダーを指定する、完全修飾された項目 ID リストへのポインターです。
cidl	DWORD	in	選択する項目の配列 apidl 内の項目数です。cidl が 0 の場合、pidlFolder は選択する単一の項目を記述した、完全に指定された ITEMIDLIST を指している必要があります。この関数は親フォルダーを開き、その項目を選択します。
apidl	ITEMIDLIST**	inoptional	PIDL 構造体の配列へのポインターです。各要素は、pidlFolder で参照される対象フォルダー内で選択する項目です。
dwFlags	DWORD	in	省略可能なフラグです。Windows XP では、このパラメーターは無視されます。Windows Vista では、次のフラグが定義されています。 OFASI_EDIT (0x0001) 項目を選択し、その名前を編集モードにします。このフラグは、単一の項目を選択する場合にのみ使用できます。複数の項目を選択する場合は無視されます。 OFASI_OPENDESKTOP (0x0002) Windows エクスプローラーのウィンドウ内ではなく、デスクトップ上で項目を選択します。デスクトップが開いているウィンドウの背後に隠れている場合、表示されない点に注意してください。

戻り値の型: HRESULT

公式ドキュメント

特定のフォルダー内の指定した項目を選択した状態で、Windows エクスプローラーのウィンドウを開きます。

戻り値

型: HRESULT

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

解説(Remarks)

SHOpenFolderAndSelectItems を使用する前に、CoInitialize または CoInitializeEx を呼び出す必要があります。呼び出さない場合、SHOpenFolderAndSelectItems は失敗します。

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

各言語での呼び出し定義

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

HRESULT SHOpenFolderAndSelectItems(
    ITEMIDLIST* pidlFolder,
    DWORD cidl,
    ITEMIDLIST** apidl,   // optional
    DWORD dwFlags
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHOpenFolderAndSelectItems(
    IntPtr pidlFolder,   // ITEMIDLIST*
    uint cidl,   // DWORD
    IntPtr apidl,   // ITEMIDLIST** optional
    uint dwFlags   // DWORD
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHOpenFolderAndSelectItems(
    pidlFolder As IntPtr,   ' ITEMIDLIST*
    cidl As UInteger,   ' DWORD
    apidl As IntPtr,   ' ITEMIDLIST** optional
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' pidlFolder : ITEMIDLIST*
' cidl : DWORD
' apidl : ITEMIDLIST** optional
' dwFlags : DWORD
Declare PtrSafe Function SHOpenFolderAndSelectItems Lib "shell32" ( _
    ByVal pidlFolder As LongPtr, _
    ByVal cidl As Long, _
    ByVal apidl As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHOpenFolderAndSelectItems = ctypes.windll.shell32.SHOpenFolderAndSelectItems
SHOpenFolderAndSelectItems.restype = ctypes.c_int
SHOpenFolderAndSelectItems.argtypes = [
    ctypes.c_void_p,  # pidlFolder : ITEMIDLIST*
    wintypes.DWORD,  # cidl : DWORD
    ctypes.c_void_p,  # apidl : ITEMIDLIST** optional
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHOpenFolderAndSelectItems = Fiddle::Function.new(
  lib['SHOpenFolderAndSelectItems'],
  [
    Fiddle::TYPE_VOIDP,  # pidlFolder : ITEMIDLIST*
    -Fiddle::TYPE_INT,  # cidl : DWORD
    Fiddle::TYPE_VOIDP,  # apidl : ITEMIDLIST** optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHOpenFolderAndSelectItems(
        pidlFolder: *mut ITEMIDLIST,  // ITEMIDLIST*
        cidl: u32,  // DWORD
        apidl: *mut *mut ITEMIDLIST,  // ITEMIDLIST** optional
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHOpenFolderAndSelectItems(IntPtr pidlFolder, uint cidl, IntPtr apidl, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHOpenFolderAndSelectItems' -Namespace Win32 -PassThru
# $api::SHOpenFolderAndSelectItems(pidlFolder, cidl, apidl, dwFlags)

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

出力引数:

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