Win32 API 日本語リファレンス
ホームDevices.FunctionDiscovery › IProviderQueryConstraintCollection

IProviderQueryConstraintCollection

COM
IID9c243e11-3261-4bcd-b922-84a873d460ae継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

このインターフェイスは、IFunctionDiscoveryProviderQuery::GetQueryConstraints メソッドを通じてプロバイダーからアクセスできます。

メソッド 6

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

vtbl 3 HRESULT GetCount(DWORD* pdwCount)

コレクション内の項目数を取得します。(IProviderQueryConstraintCollection.GetCount)

pdwCountDWORD*out項目数。

戻り値

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

vtbl 4 HRESULT Get(LPWSTR pszConstraintName, WORD** ppszConstraintValue)

指定したクエリ制約の値を、名前を指定して取得します。

pszConstraintNameLPWSTRin制約の名前。
ppszConstraintValueWORD**out制約の値。

戻り値

戻り値には、次のものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドは正常に完了しました。
S_FALSE
メソッドは正常に完了しましたが、プロパティキーがコレクション内で見つかりませんでした。
E_POINTER
pszConstraintName または ppszConstraintValue パラメーターが NULL です。
vtbl 5 HRESULT Item(DWORD dwIndex, WORD** ppszConstraintName, WORD** ppszConstraintValue)

指定したクエリ制約の名前と値を、インデックスを指定して取得します。

dwIndexDWORDinコレクション内の項目のインデックス。
ppszConstraintNameWORD**out制約の名前。
ppszConstraintValueWORD**out制約の値。

戻り値

戻り値には、次のものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドは正常に完了しました。
E_POINTER
pszConstraintName または ppszConstraintValue パラメーターが NULL です。
vtbl 6 HRESULT Next(WORD** ppszConstraintName, WORD** ppszConstraintValue)

コレクション内の次のクエリ制約の名前と値を取得します。

ppszConstraintNameWORD**out制約の名前。
ppszConstraintValueWORD**out制約の値。

戻り値

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

vtbl 7 HRESULT Skip()

コレクション内の次の項目をスキップします。(IProviderQueryConstraintCollection.Skip)

戻り値

戻り値には、次のものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドは正常に完了しました。

解説(Remarks)

このメソッドは、項目取得の呼び出しの有無にかかわらず、コレクションの先頭から動作します。

vtbl 8 HRESULT Reset()

現在のインデックスをコレクションの先頭にリセットします。(IProviderQueryConstraintCollection.Reset)

戻り値

戻り値には、次のものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドは正常に完了しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IProviderQueryConstraintCollection "{9C243E11-3261-4BCD-B922-84A873D460AE}"
#usecom global IProviderQueryConstraintCollection IID_IProviderQueryConstraintCollection "{}"
#comfunc global IProviderQueryConstraintCollection_GetCount  3 var
#comfunc global IProviderQueryConstraintCollection_Get       4 wstr,var
#comfunc global IProviderQueryConstraintCollection_Item      5 int,var,var
#comfunc global IProviderQueryConstraintCollection_Next      6 var,var
#comfunc global IProviderQueryConstraintCollection_Skip      7
#comfunc global IProviderQueryConstraintCollection_Reset     8
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。