ISearchProtocol2

COM

IID7789f0b2-b5b2-4722-8b65-5dbd150697a9継承元ISearchProtocol自前メソッド開始 vtbl7

公式ドキュメント

IUrlAccessor オブジェクトの呼び出し、初期化、および管理を行うメソッドを提供します。(ISearchProtocol2)

メソッド 1

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 7 HRESULT CreateAccessorEx(LPWSTR pcwszURL, AUTHENTICATION_INFO* pAuthenticationInfo, INCREMENTAL_ACCESS_INFO* pIncrementalAccessInfo, ITEM_INFO* pItemInfo, BLOB* pUserData, IUrlAccessor** ppAccessor)

IUrlAccessor オブジェクトを作成して初期化します。このメソッドは ISearchProtocol::CreateAccessor メソッドと基本的に同じ機能を持ちますが、プロトコルハンドラーに追加のデータを渡すための pUserData パラメーターが追加されています。

pcwszURL	LPWSTR	in	アクセス対象アイテムの URL を格納した、null で終わる Unicode 文字列へのポインター。
pAuthenticationInfo	AUTHENTICATION_INFO*	in	コンテンツソース内のこのアイテムにアクセスするために必要な認証情報を格納した AUTHENTICATION_INFO 構造体へのポインター。
pIncrementalAccessInfo	INCREMENTAL_ACCESS_INFO*	in	ギャザラーが最後にファイルにアクセスした日時など、増分アクセス情報を格納した INCREMENTAL_ACCESS_INFO 構造体へのポインター。
pItemInfo	ITEM_INFO*	in	アイテムのワークスペースカタログ名など、URL アイテムに関する情報を格納した ITEM_INFO 構造体へのポインター。
pUserData	BLOB*	in	ユーザー情報へのポインター。このデータは通知の発行元が任意に決定できます。プロトコルハンドラーがこのインターフェイスを実装している場合、このデータを受け取ります。すべての通知でこの BLOB が設定されているわけではありません。
ppAccessor	IUrlAccessor**	out	このメソッドによって作成された IUrlAccessor オブジェクトへのポインターのアドレスを受け取ります。このオブジェクトには、アイテムのファイル名など、URL アイテムに関する情報が格納されます。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは、ギャザラーが現在アクセスしているアイテムを処理するために IUrlAccessor オブジェクトを作成して初期化します。プロトコルホストが、プロトコルハンドラーに対してこのメソッドを呼び出します。このメソッドはギャザラーが処理する URL ごとに 1 回呼び出され、IUrlAccessor オブジェクトへのポインターを取得します。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ISearchProtocol2 "{7789F0B2-B5B2-4722-8B65-5DBD150697A9}"
#usecom global ISearchProtocol2 IID_ISearchProtocol2 "{}"
#comfunc global ISearchProtocol2_CreateAccessorEx  7 wstr,var,var,var,var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ISearchProtocol2 "{7789F0B2-B5B2-4722-8B65-5DBD150697A9}"
#usecom global ISearchProtocol2 IID_ISearchProtocol2 "{}"
#comfunc global ISearchProtocol2_CreateAccessorEx  7 wstr,sptr,sptr,sptr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。