ホーム › UI.Shell › SHBindToFolderIDListParent

SHBindToFolderIDListParent

関数

ルート基準でPIDLの親フォルダーにバインドする。

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

シグネチャ

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

HRESULT SHBindToFolderIDListParent(
    IShellFolder* psfRoot,   // optional
    ITEMIDLIST* pidl,
    const GUID* riid,
    void** ppv,
    ITEMIDLIST** ppidlLast   // optional
);

パラメーター

名前	型	方向	説明
psfRoot	IShellFolder*	inoptional	Shell フォルダーオブジェクトへのポインター。psfRoot が NULL の場合、渡される IDList がデスクトップを基準とした相対的なものであることを示します。
pidl	ITEMIDLIST*	in	バインド先となる、psfRoot を基準とした相対 PIDL。psfRoot が NULL の場合、これはデスクトップフォルダーを基準とした絶対 IDList です。
riid	GUID*	in	目的のインターフェイス ID への参照。通常は IID_IShellFolder または IID_IShellFolder2 ですが、対象フォルダーがサポートするものであれば何でも指定できます。
ppv	void**	out	この関数が返るとき、riid で要求されたインターフェイスポインターが格納されます。通常は IShellFolder または IShellFolder2 ですが、対象フォルダーがサポートするものであれば何でもかまいません。
ppidlLast	ITEMIDLIST**	outoptional	pidl パラメーターの最後の ID へのポインターであり、ppv で返される親フォルダーを基準とした子 ID です。この値は NULL でもかまいません。

戻り値の型: HRESULT

公式ドキュメント

フォルダーの形式で指定された Shell 名前空間の項目と、そのフォルダーを基準とした項目識別子リストを指定すると、この関数は名前空間項目の親にバインドし、必要に応じて項目識別子リストの最終コンポーネントへのポインターを返します。

戻り値

型: HRESULT

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

解説(Remarks)

注意 SHBindToFolderIDListParent 関数を呼び出すことは、SHBindToFolderIDListParentEx 関数をバインドコンテキストとして NULL を指定して呼び出すことと同等です。

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

各言語での呼び出し定義

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

HRESULT SHBindToFolderIDListParent(
    IShellFolder* psfRoot,   // optional
    ITEMIDLIST* pidl,
    const GUID* riid,
    void** ppv,
    ITEMIDLIST** ppidlLast   // optional
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHBindToFolderIDListParent(
    IntPtr psfRoot,   // IShellFolder* optional
    IntPtr pidl,   // ITEMIDLIST*
    ref Guid riid,   // GUID*
    IntPtr ppv,   // void** out
    IntPtr ppidlLast   // ITEMIDLIST** optional, out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHBindToFolderIDListParent(
    psfRoot As IntPtr,   ' IShellFolder* optional
    pidl As IntPtr,   ' ITEMIDLIST*
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr,   ' void** out
    ppidlLast As IntPtr   ' ITEMIDLIST** optional, out
) As Integer
End Function

' psfRoot : IShellFolder* optional
' pidl : ITEMIDLIST*
' riid : GUID*
' ppv : void** out
' ppidlLast : ITEMIDLIST** optional, out
Declare PtrSafe Function SHBindToFolderIDListParent Lib "shell32" ( _
    ByVal psfRoot As LongPtr, _
    ByVal pidl As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr, _
    ByVal ppidlLast As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHBindToFolderIDListParent = ctypes.windll.shell32.SHBindToFolderIDListParent
SHBindToFolderIDListParent.restype = ctypes.c_int
SHBindToFolderIDListParent.argtypes = [
    ctypes.c_void_p,  # psfRoot : IShellFolder* optional
    ctypes.c_void_p,  # pidl : ITEMIDLIST*
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
    ctypes.c_void_p,  # ppidlLast : ITEMIDLIST** optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHBindToFolderIDListParent = Fiddle::Function.new(
  lib['SHBindToFolderIDListParent'],
  [
    Fiddle::TYPE_VOIDP,  # psfRoot : IShellFolder* optional
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST*
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
    Fiddle::TYPE_VOIDP,  # ppidlLast : ITEMIDLIST** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHBindToFolderIDListParent(
        psfRoot: *mut core::ffi::c_void,  // IShellFolder* optional
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST*
        riid: *const GUID,  // GUID*
        ppv: *mut *mut (),  // void** out
        ppidlLast: *mut *mut ITEMIDLIST  // ITEMIDLIST** optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHBindToFolderIDListParent(IntPtr psfRoot, IntPtr pidl, ref Guid riid, IntPtr ppv, IntPtr ppidlLast);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHBindToFolderIDListParent' -Namespace Win32 -PassThru
# $api::SHBindToFolderIDListParent(psfRoot, pidl, riid, ppv, ppidlLast)

#uselib "SHELL32.dll"
#func global SHBindToFolderIDListParent "SHBindToFolderIDListParent" sptr, sptr, sptr, sptr, sptr
; SHBindToFolderIDListParent psfRoot, varptr(pidl), varptr(riid), ppv, varptr(ppidlLast)   ; 戻り値は stat
; psfRoot : IShellFolder* optional -> "sptr"
; pidl : ITEMIDLIST* -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ppidlLast : ITEMIDLIST** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHBindToFolderIDListParent "SHBindToFolderIDListParent" sptr, var, var, sptr, var
; res = SHBindToFolderIDListParent(psfRoot, pidl, riid, ppv, ppidlLast)
; psfRoot : IShellFolder* optional -> "sptr"
; pidl : ITEMIDLIST* -> "var"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ppidlLast : ITEMIDLIST** optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHBindToFolderIDListParent "SHBindToFolderIDListParent" sptr, sptr, sptr, sptr, sptr
; res = SHBindToFolderIDListParent(psfRoot, varptr(pidl), varptr(riid), ppv, varptr(ppidlLast))
; psfRoot : IShellFolder* optional -> "sptr"
; pidl : ITEMIDLIST* -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ppidlLast : ITEMIDLIST** optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。