ホーム › Devices.FunctionDiscovery › IFunctionDiscoveryProviderQuery

IFunctionDiscoveryProviderQuery

COM

📘 Microsoft Learn (日本語) · English

IID6876ea98-baec-46db-bc20-75a76e267a3a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

このインターフェイスは、すべての IFunctionDiscoveryProvider::Query メソッド呼び出しに渡され、クエリ定義情報を格納します。プロバイダーは、受信する各クエリ要求の制約を判断するためにこれを使用します。

メソッド 4

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

vtbl 3 HRESULT IsInstanceQuery(BOOL* pisInstanceQuery, WORD** ppszConstraintValue)

クエリが単一の関数インスタンスを対象とするか、複数の関数インスタンスを対象とするかを判定します。

pisInstanceQuery	BOOL*	out	このパラメーターが TRUE の場合、クエリ制約コレクションにプロバイダーインスタンス識別子制約が存在します。
ppszConstraintValue	WORD**	out	プロバイダーインスタンス識別子制約の値。

戻り値

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

vtbl 4 HRESULT IsSubcategoryQuery(BOOL* pisSubcategoryQuery, WORD** ppszConstraintValue)

クエリが特定のサブカテゴリ内の関数インスタンスを対象とするかどうかを判定します。

pisSubcategoryQuery	BOOL*	out	このパラメーターが TRUE の場合、クエリ制約コレクションにサブカテゴリ制約が存在します。
ppszConstraintValue	WORD**	out	サブカテゴリ制約の値。

戻り値

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

解説(Remarks)

プロバイダーがサブカテゴリをサポートしていない場合、プロバイダーはクエリへの応答として、インスタンス数が 0 の IFunctionInstanceCollection を返す必要があります。

vtbl 5 HRESULT GetQueryConstraints(IProviderQueryConstraintCollection** ppIProviderQueryConstraints)

現在のクエリ制約を取得します。

ppIProviderQueryConstraints

IProviderQueryConstraintCollection**

out

クエリ制約のコレクションを受け取る IProviderQueryConstraintCollection インターフェイスポインターへのポインター。

戻り値

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

解説(Remarks)

プロバイダーは、結果を返す際にすべてのクエリ制約を適用することが求められます。認識できないクエリ制約は無視してください。

プロバイダーは、実行するクエリを判断するためにすべての制約を確認する必要があります。

vtbl 6 HRESULT GetPropertyConstraints(IProviderPropertyConstraintCollection** ppIProviderPropertyConstraints)

現在のプロパティ制約を取得します。

ppIProviderPropertyConstraints

IProviderPropertyConstraintCollection**

out

プロパティ制約のコレクションを受け取る IProviderPropertyConstraintCollection インターフェイスポインターへのポインター。

戻り値

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

解説(Remarks)

Function Discovery は、プロバイダーが返した結果にすべてのプロパティ制約を適用しますが、プロバイダー側で結果にプロパティ制約を適用できる場合はより効率的です。

プロバイダーは、実行するクエリを判断するためにすべての制約を確認する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFunctionDiscoveryProviderQuery "{6876EA98-BAEC-46DB-BC20-75A76E267A3A}"
#usecom global IFunctionDiscoveryProviderQuery IID_IFunctionDiscoveryProviderQuery "{}"
#comfunc global IFunctionDiscoveryProviderQuery_IsInstanceQuery         3 var,var
#comfunc global IFunctionDiscoveryProviderQuery_IsSubcategoryQuery      4 var,var
#comfunc global IFunctionDiscoveryProviderQuery_GetQueryConstraints     5 sptr
#comfunc global IFunctionDiscoveryProviderQuery_GetPropertyConstraints  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IFunctionDiscoveryProviderQuery "{6876EA98-BAEC-46DB-BC20-75A76E267A3A}"
#usecom global IFunctionDiscoveryProviderQuery IID_IFunctionDiscoveryProviderQuery "{}"
#comfunc global IFunctionDiscoveryProviderQuery_IsInstanceQuery         3 sptr,sptr
#comfunc global IFunctionDiscoveryProviderQuery_IsSubcategoryQuery      4 sptr,sptr
#comfunc global IFunctionDiscoveryProviderQuery_GetQueryConstraints     5 sptr
#comfunc global IFunctionDiscoveryProviderQuery_GetPropertyConstraints  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。