IUPnPDeviceControl
COM公式ドキュメント
IUPnPDeviceControl インターフェイスは、デバイスとそのサービス オブジェクトを管理する中心的な役割を担います。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
Initialize メソッドは、デバイスを初期化するために使用します。このメソッドはデバイス ホストによって呼び出されます。
| bstrXMLDesc | LPWSTR | in | デバイス ホストによって公開される、完全な XML デバイス記述を指定します。このデバイス記述は、デバイスが提供するテンプレートに基づいて生成されます。 |
| bstrDeviceIdentifier | LPWSTR | in | 初期化するデバイスを識別します。これは IUPnPRegistrar::RegisterDevice または IUPnPRegistrar::RegisterRunningDevice が返す識別子と同じものです。また、 IUPnPRegistrar::GetUniqueDeviceName を使用してデバイスの UDN を取得する際にも使用されます。 |
| bstrInitString | LPWSTR | in | このデバイスを登録したときに使用した初期化文字列を指定します。 |
戻り値
このメソッドを実装する場合、成功したときは S_OK を返します。それ以外の場合は、WinError.h に定義されている COM エラー コードのいずれかを返します。
解説(Remarks)
このメソッドは、デバイス コントロール オブジェクトがインスタンス化された直後に呼び出されます。 IUPnPDeviceControl::GetServiceObject よりも前に呼び出される必要があります。
実行中のデバイスとそうでないデバイスの違いは、 Initialize メソッドが呼び出されるタイミングにあります。
実行中のデバイスの場合、 Initialize は IUPnPRegistrar::RegisterRunningDevice の呼び出し時に呼び出され、IUPnPRegistrar::RegisterRunningDevice が復帰する前に初期化が完了します。
実行中でないデバイスの場合、 IUPnPRegistrar::RegisterDevice の呼び出し時に Initialize が呼び出されるとは限りません。 Initialize は、最初のコントロール要求またはイベント要求が到着した時点で呼び出されます。
bstrDeviceIdentifier は、 IUPnPRegistrar::GetUniqueDeviceName を呼び出す際にも使用できます。
GetServiceObject メソッドは、特定のサービス オブジェクトへの IDispatch ポインターを取得するために使用します。デバイス ホストは、あるサービスに対する要求を最初に受け取ったときに、そのサービスごとに 1 回このメソッドを呼び出します。
| bstrUDN | LPWSTR | in | デバイスの UDN を指定します。 |
| bstrServiceId | LPWSTR | in | ポインターを取得する対象となるサービスの Service ID を指定します。 |
| ppdispService | IDispatch** | out | サービス オブジェクトへの IDispatch ポインターを受け取ります。 |
戻り値
このメソッドを実装する場合、成功したときは S_OK を返します。それ以外の場合は、WinError.h に定義されている COM エラー コードのいずれかを返します。
解説(Remarks)
このメソッドは、特定のサービスに対するコントロール要求またはイベント サブスクリプションを受信したときに、デバイス ホストによって呼び出されます。
埋め込みデバイスは、それぞれの UDN によって区別されます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IUPnPDeviceControl "{204810BA-73B2-11D4-BF42-00B0D0118B56}"
#usecom global IUPnPDeviceControl IID_IUPnPDeviceControl "{}"
#comfunc global IUPnPDeviceControl_Initialize 3 wstr,wstr,wstr
#comfunc global IUPnPDeviceControl_GetServiceObject 4 wstr,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。