SHBindToParent

関数

PIDLの親フォルダーにバインドし最終アイテムを取得する。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
pidl	ITEMIDLIST*	in	アイテムの PIDL。
riid	GUID*	in	アイテムの親オブジェクトが公開するインターフェイスのいずれかの REFIID。
ppv	void**	out	riid で指定されたインターフェイスへのポインター。処理が完了したら、オブジェクトを解放する必要があります。
ppidlLast	ITEMIDLIST**	outoptional	親フォルダーを基準とするアイテムの PIDL。この PIDL は、親フォルダーのインターフェイスがサポートする多くのメソッドで使用できます。ppidlLast を NULL に設定すると、PIDL は返されません。注意 SHBindToParent は新しい PIDL を割り当てません。このパラメーターを通じてポインターを受け取るだけです。したがって、このリソースを解放する必要はありません。

戻り値の型: HRESULT

公式ドキュメント

完全修飾アイテム識別子リスト (PIDL) へのポインターを受け取り、親オブジェクト上の指定されたインターフェイスポインターを返します。

戻り値

型: 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 SHBindToParent(
    ITEMIDLIST* pidl,
    const GUID* riid,
    void** ppv,
    ITEMIDLIST** ppidlLast   // optional
);

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

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

' pidl : ITEMIDLIST*
' riid : GUID*
' ppv : void** out
' ppidlLast : ITEMIDLIST** optional, out
Declare PtrSafe Function SHBindToParent Lib "shell32" ( _
    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

SHBindToParent = ctypes.windll.shell32.SHBindToParent
SHBindToParent.restype = ctypes.c_int
SHBindToParent.argtypes = [
    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')
SHBindToParent = Fiddle::Function.new(
  lib['SHBindToParent'],
  [
    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 SHBindToParent(
        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 SHBindToParent(IntPtr pidl, ref Guid riid, IntPtr ppv, IntPtr ppidlLast);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHBindToParent' -Namespace Win32 -PassThru
# $api::SHBindToParent(pidl, riid, ppv, ppidlLast)

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

出力引数:

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