IVdsHwProvider
COM公式ドキュメント
IVdsHwProvider (vdshwprv.h) インターフェイスは、ハードウェアプロバイダーに対するクエリ、再列挙、および更新の操作を実行するためのメソッドを提供します。
メソッド 3
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
IVdsHwProvider::QuerySubSystems (vdshwprv.h) メソッドは、プロバイダーが管理するサブシステムの列挙を返します。
| ppEnum | IEnumVdsObject** | out | サブシステムを サブシステムオブジェクト として列挙するために使用できる IEnumVdsObject インターフェイス ポインターのアドレスです。詳細については、列挙オブジェクトの操作 を参照してください。呼び出し元は、インターフェイスおよび各サブシステムオブジェクトが不要になったら、IUnknown::Release メソッドを呼び出して解放する必要があります。 |
戻り値
このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことができます。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用されている基盤の VDS プロバイダー から発生する可能性があります。返される可能性のある値には、次のものが含まれます。
| 戻りコード/値 | 説明 |
|---|---|
| サブシステム識別子の列挙を返します。プロバイダーがサブシステムを管理していない場合、この列挙 は空になります。 | |
|
この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を 示します。キャッシュを復元するには、 IVdsHwProvider::Reenumerate メソッド に続けて IVdsHwProvider::Refresh メソッドを使用します。 |
|
プロバイダーが失敗した状態にあり、要求された操作を実行できません。 |
|
別の操作が進行中です。この操作は、前の操作が 完了するまで続行できません。 |
|
初期化メソッドが呼び出されていません。 |
解説(Remarks)
返されるオブジェクトは、現在ネットワークに接続されているすべてのサブシステムを列挙します。新しいサブシステムを検出するには、 IVdsHwProvider::Reenumerate メソッドを使用します。既存のサブシステムについて内部にキャッシュされたプロバイダーデータを更新するには、 IVdsHwProvider::Refresh メソッドを使用します。
IVdsHwProvider::Reenumerate (vdshwprv.h) メソッドは、新たに接続および切断されたサブシステムを検出します。
戻り値
このメソッドは、E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことができます。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用されている基盤の VDS プロバイダー から発生する可能性があります。返される可能性のある値には、次のものが含まれます。
| 戻りコード/値 | 説明 |
|---|---|
|
この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を 示します。キャッシュを復元するには、 IVdsHwProvider::Reenumerate メソッド に続けて IVdsHwProvider::Refresh メソッドを使用します。 |
|
プロバイダーが失敗した状態にあり、要求された操作を実行できません。 |
|
別の操作が進行中です。この操作は、前の操作が 完了するまで続行できません。 |
|
初期化メソッドが呼び出されていません。 |
解説(Remarks)
このメソッドに関連付けられたネットワーククエリは、完了までに長い時間がかかることがあります。単に 内部にキャッシュされたプロバイダーデータを更新したいだけの場合は、代わりに IVdsHwProvider::Refresh メソッドを使用してください。
IVdsHwProvider::Refresh (vdshwprv.h) メソッドは、VDS プロバイダーが管理する既存のサブシステムについて、VDS が内部にキャッシュしているデータを更新します。
戻り値
このメソッドは、E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことができます。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用されている基盤の VDS プロバイダー から発生する可能性があります。返される可能性のある値には、次のものが含まれます。
| 戻りコード/値 | 説明 |
|---|---|
|
この戻り値は、アレイに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を 示します。キャッシュを復元するには、 IVdsHwProvider::Reenumerate メソッド に続けて IVdsHwProvider::Refresh メソッドを使用します。 |
|
プロバイダーが失敗した状態にあり、要求された操作を実行できません。 |
|
別の操作が進行中です。この操作は、前の操作が 完了するまで続行できません。 |
|
初期化メソッドが呼び出されていません。 |
解説(Remarks)
VDS は、サブシステムやコントローラーなど、すべての VDS オブジェクトのプロパティに関する情報のキャッシュを保持します。通知をトリガーする変更が発生するたびに、このキャッシュは更新されます。キャッシュが適切に更新されない場合、アプリケーションはこのメソッドを呼び出してキャッシュを更新できます。このメソッドを呼び出してキャッシュを更新すると、さらに追加の通知がトリガーされる場合があることに注意してください。
このメソッドは、新たに接続されたサブシステムを見つけるためにネットワークをクエリすることはありません。新たに接続および切断された サブシステムを検出するには、 IVdsHwProvider::Reenumerate メソッドを使用してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IVdsHwProvider "{D99BDAAE-B13A-4178-9FDB-E27F16B4603E}"
#usecom global IVdsHwProvider IID_IVdsHwProvider "{}"
#comfunc global IVdsHwProvider_QuerySubSystems 3 sptr
#comfunc global IVdsHwProvider_Reenumerate 4
#comfunc global IVdsHwProvider_Refresh 5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。