QISearch

関数

テーブルに基づきQueryInterfaceの問い合わせを処理する。

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

シグネチャ

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

HRESULT QISearch(
    void* that,
    QITAB* pqit,
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
that	void*	inout	COM オブジェクトのベースへのポインター。
pqit	QITAB*	in	QITAB 構造体の配列です。配列の最後の構造体は、piid メンバーを NULL に、dwOffset メンバーを 0 に設定する必要があります。
riid	GUID*	in	ppv を通じて取得するインターフェイスの IID への参照。
ppv	void**	out	このメソッドが正常に返ったとき、riid で要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

IUnknown::QueryInterface メソッドのテーブル駆動型の実装です。

戻り値

型: HRESULT

要求されたインターフェイスがテーブル内で見つかった場合、または要求されたインターフェイスが IUnknown であった場合は S_OK を返します。要求されたインターフェイスが見つからなかった場合は E_NOINTERFACE を返します。

解説(Remarks)

注意 Windows Vista より前では、QISearch は名前でエクスポートされておらず、パブリックなヘッダーファイルでも宣言されていませんでした。そのような場合に使用するには、GetProcAddress を使用し、Shlwapi.dll から序数 219 を要求して関数ポインターを取得する必要があります。Windows Vista では QISearch は Shlwapi.h に含まれており、この処理は不要です。

要求されたインターフェイスが IUnknown の場合、QISearch は指定された QITAB 構造体配列の最初のエントリを使用します。それ以外の場合、QISearch は一致する IID が見つかるか、テーブルの終端に達するまでテーブルを検索します。一致する IID が見つかると、関数は対応するインターフェイスポインターを、そのインターフェイスの QITAB 構造体の dwOffset メンバーで指定されたバイト数だけ進め、COM ポインターとして再解釈します。そのポインターが QISearch 関数の ppv パラメーターに代入されます。このメソッドはまた、IUnknown::AddRef を呼び出してインターフェイスの参照カウントをインクリメントします。

QISearch がインターフェイスを見つけられずにテーブルの終端に達した場合、E_NOINTERFACE を返し、ppv を NULL に設定します。

該当するすべてのインターフェイスをテーブルに含めることが重要です。たとえば、オブジェクトが派生インターフェイスを実装している場合は、その基底インターフェイスもテーブルに含める必要があります。

riid および ppv パラメーターをまとめるには、Objbase.h で定義されている IID_PPV_ARGS マクロを使用することをお勧めします。このマクロは ppv が指す値のインターフェイスに基づいて正しい IID を提供するため、予期しない結果につながる riid のコーディングミスの可能性を排除できます。

注意 Active Template Library (ATL) は、QueryInterface のテーブル駆動型実装の、はるかに優れたバージョンを提供しています。

例

次の例は、QISearch を使用して QueryInterface を実装する方法を示しています。ATL の offsetofclass マクロを使用して、CSample オブジェクトのベースから指定したインターフェイスまでのオフセットを計算します。

このオブジェクトは IUnknown 以外に 2 つのインターフェイスをサポートしているため、QITAB テーブルには NULL 以外のエントリが 2 つあります。各インターフェイスのエントリは、対応する IID へのポインター (IID_IPersist または IID_IPersistFolder) と、クラスのベースポインターを基準としたインターフェイスポインターのオフセットを指定します。このサンプルでは、そのオフセットを求めるために ATL の offsetofclass マクロを使用しています。

注意間接的な基底クラスを含むすべての基底クラスを含め忘れることは、よくある誤りです。IPersist インターフェイスのエントリがあることに注目してください。このインターフェイスは、IPersistFolder を通じて継承される、CSample の間接的な基底クラスです。


class CSample : public IPersistFolder
{
  public:
    CSample() { /* other construction goes here */ }
    
    STDMETHODIMP QueryInterface(REFIID riid, void **ppv);
    STDMETHODIMP_(ULONG) AddRef();
    STDMETHODIMP_(ULONG) Release();
  
    // *** IPersist ***
    STDMETHODIMP GetClassID(CLSID *pClassID);
    
    // *** IPersistFolder ***
    STDMETHODIMP Initialize(LPCITEMIDLIST pidl);
  
  private:
  // private members go here
};

HRESULT CSample::QueryInterface(REFIID riid, void **ppv)
{
    static QITAB rgqit[] = 
    {   
        QITABENT(CSample, IPersist),
        QITABENT(CSample, IPersistFolder)
        { 0 },
    };

    return QISearch(this, rgqit, IID_PPV_ARGS(&ppv));
}

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

各言語での呼び出し定義

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

HRESULT QISearch(
    void* that,
    QITAB* pqit,
    const GUID* riid,
    void** ppv
);

[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int QISearch(
    IntPtr that,   // void* in/out
    IntPtr pqit,   // QITAB*
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function QISearch(
    that As IntPtr,   ' void* in/out
    pqit As IntPtr,   ' QITAB*
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' that : void* in/out
' pqit : QITAB*
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function QISearch Lib "shlwapi" ( _
    ByVal that As LongPtr, _
    ByVal pqit 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

QISearch = ctypes.windll.shlwapi.QISearch
QISearch.restype = ctypes.c_int
QISearch.argtypes = [
    ctypes.POINTER(None),  # that : void* in/out
    ctypes.c_void_p,  # pqit : QITAB*
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
QISearch = Fiddle::Function.new(
  lib['QISearch'],
  [
    Fiddle::TYPE_VOIDP,  # that : void* in/out
    Fiddle::TYPE_VOIDP,  # pqit : QITAB*
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn QISearch(
        that: *mut (),  // void* in/out
        pqit: *mut QITAB,  // QITAB*
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int QISearch(IntPtr that, IntPtr pqit, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_QISearch' -Namespace Win32 -PassThru
# $api::QISearch(that, pqit, riid, ppv)

#uselib "SHLWAPI.dll"
#func global QISearch "QISearch" sptr, sptr, sptr, sptr
; QISearch that, varptr(pqit), varptr(riid), ppv   ; 戻り値は stat
; that : void* in/out -> "sptr"
; pqit : QITAB* -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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