SHBindToObject

関数

PIDLが指すオブジェクトにバインドしインターフェイスを取得する。

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

シグネチャ

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

HRESULT SHBindToObject(
    IShellFolder* psf,   // optional
    ITEMIDLIST* pidl,
    IBindCtx* pbc,   // optional
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
psf	IShellFolder*	inoptional	IShellFolder へのポインターです。このパラメーターは NULL にすることができます。psf が NULL の場合、パラメーター pidl はデスクトップに対する相対パスであることを示します。この場合、pidl には絶対 ITEMIDLIST を指定する必要があります。
pidl	ITEMIDLIST*	in	psf に対する相対パスでバインド先となる定数 ITEMIDLIST へのポインターです。psf が NULL の場合、これはデスクトップフォルダーに対する相対の絶対 ITEMIDLIST です。
pbc	IBindCtx*	inoptional	この操作中に使用されるバインドコンテキストオブジェクト上の IBindCtx インターフェイスへのポインターです。このパラメーターを使用しない場合は NULL に設定します。pbc のサポートはフォルダーオブジェクトの実装では省略可能であるため、一部のフォルダーはバインドコンテキストの使用をサポートしない場合があります。
riid	GUID*	in	返すインターフェイスの識別子です。
ppv	void**	out	このメソッドが返るとき、バインドされたオブジェクトに対して riid で指定されたインターフェイスポインターを格納します。エラーが発生した場合は NULL ポインターを格納します。

戻り値の型: HRESULT

公式ドキュメント

Shell 名前空間の IShellFolder::BindToObject メソッドを使用して、指定されたオブジェクトを取得し、それにバインドします。

戻り値

型: HRESULT

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

解説(Remarks)

注意これは、SHGetDesktopFolder を呼び出してデスクトップオブジェクトを取得するヘルパー関数です。

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

各言語での呼び出し定義

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

HRESULT SHBindToObject(
    IShellFolder* psf,   // optional
    ITEMIDLIST* pidl,
    IBindCtx* pbc,   // optional
    const GUID* riid,
    void** ppv
);

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

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

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

import ctypes
from ctypes import wintypes

SHBindToObject = ctypes.windll.shell32.SHBindToObject
SHBindToObject.restype = ctypes.c_int
SHBindToObject.argtypes = [
    ctypes.c_void_p,  # psf : IShellFolder* optional
    ctypes.c_void_p,  # pidl : ITEMIDLIST*
    ctypes.c_void_p,  # pbc : IBindCtx* optional
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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