ホーム › Devices.Enumeration.Pnp › IUPnPDeviceFinder

IUPnPDeviceFinder

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IIDadda3d55-6f72-4319-bff9-18600a539b10継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IUPnPDeviceFinder インターフェイスは、アプリケーションがデバイスを検索できるようにします。

メソッド 5

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT FindByType(LPWSTR bstrTypeURI, DWORD dwFlags, IUPnPDevices** pDevices)

FindByType メソッドは、デバイスの種類またはサービスの種類を指定して、同期的にデバイスを検索します。

bstrTypeURI	LPWSTR	in	検索対象となるデバイスの種類またはサービスの種類の型 URI を指定します。
dwFlags	DWORD	in	0 でなければなりません。このパラメーターは将来の使用のために予約されています。
pDevices	IUPnPDevices**	out	見つかったデバイスのコレクションである IUPnPDevices への参照を受け取ります。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

このメソッドは検索が完了するまで制御を返しません。検索には少なくとも 9 秒、場合によってはそれ以上かかることがあります。このメソッドを、ユーザーインターフェイスのメッセージを処理するスレッドから呼び出してはなりません。

vtbl 8 HRESULT CreateAsyncFind(LPWSTR bstrTypeURI, DWORD dwFlags, IUnknown* punkDeviceFinderCallback, INT* plFindData)

CreateAsyncFind メソッドは、非同期の検索操作を作成します。

bstrTypeURI	LPWSTR	in	検索対象となる Uniform Resource Identifier (URI) を指定します。
dwFlags	DWORD	in	0 を指定します。このパラメーターは将来の使用のために予約されています。
punkDeviceFinderCallback	IUnknown*	in	IUnknown インターフェイスオブジェクトへの参照です。UPnP フレームワークがこの非同期検索の結果を通知するために使用するコールバックを指定します。 pUnkCallback が参照するオブジェクトは、 IUPnPDeviceFinderCallback インターフェイスまたは IDispatch インターフェイスのいずれかをサポートしている必要があります。また、pUnkCallback が参照するオブジェクトは、IUPnPDeviceFinderCallback インターフェイスに加えて IUPnPDeviceFinderAddCallbackWithInterface インターフェイスをサポートしていてもかまいません。
plFindData	INT*	out	今回の検索の識別子を受け取る LONG への参照です。アプリケーションは、呼び出す他の非同期検索メソッドにこの識別子を渡す必要があります。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

このメソッドはすぐに制御を返します。UPnP フレームワークは、pUnkCallback で指定されたコールバックを使用して検索結果を呼び出し元に通知します。このメソッドは検索識別子を返しますが、実際に検索を開始するには、呼び出し元が IUPnPDeviceFinder::StartAsyncFind を使用する必要があります。

C++ では、pUnkCallback が参照するオブジェクトは、IUPnPDeviceFinderCallback インターフェイスまたは IDispatch インターフェイスのいずれかをサポートしている必要があります。必要に応じて、pUnkCallback が参照するオブジェクトは、IUPnPDeviceFinderCallback インターフェイスに加えて IUPnPDeviceFinderAddCallbackWithInterface インターフェイスをサポートすることもできます。UPnP フレームワークは、まず pUnkCallback に対して IUPnPDeviceFinderAddCallbackWithInterface インターフェイスを照会します。そのインターフェイスがサポートされていない場合、次に IUPnPDeviceFinderCallback インターフェイスを照会します。それもサポートされていない場合は、IDispatch インターフェイスを照会します。IDispatch インターフェイスもサポートされていない場合、UPnP フレームワークは E_FAIL を返します。

VBScript では、2 番目の引数を GetRef(funcname) にする必要があります。funcname はコールバックとなるサブルーチンの名前です。

Visual Basic では、コールバック関数を 3 つのパラメーターで宣言する必要があります。コールバック関数は、各パラメーターに指定された値を使用します。

param1 は新しいデバイスの Device オブジェクトです。param3 が 0 の場合にのみ有効です。
param2 は、見つかったデバイスまたは削除されたデバイスの UDN です。param3 が 0 または 1 の場合にのみ有効です。
param3 はコールバックの種類です。有効な値は次のとおりです。

0 — 新しいデバイスを示します。

1 — デバイスが削除されたことを示します。

2 — 検索が完了したことを示します。

vtbl 9 HRESULT StartAsyncFind(INT lFindData)

StartAsyncFind メソッドは、非同期の検索操作を開始します。

lFindData

INT

開始する検索を指定します。lFindData の値は、以前に呼び出した IUPnPDeviceFinder::CreateAsyncFind が返した値です。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

複数の StartAsyncFind 操作を同時に実行できます。別の StartAsyncFind を開始しても、以前の StartAsyncFind 操作が取り消されることはありません。

vtbl 10 HRESULT CancelAsyncFind(INT lFindData)

CancelAsyncFind メソッドは、非同期の検索を取り消します。

lFindData

INT

取り消す検索を指定します。lFindData の値は、以前に呼び出した IUPnPDeviceFinder::CreateAsyncFind が返した値です。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

アプリケーションは、終了するまで非同期検索を実行し続けることができます。アプリケーションを終了する際には、未完了の操作を必ず取り消してください。

vtbl 11 HRESULT FindByUDN(LPWSTR bstrUDN, IUPnPDevice** pDevice)

FindByUDN メソッドは、一意のデバイス名 (UDN) を指定して、同期的にデバイスを検索します。

bstrUDN	LPWSTR	in	検索対象の UDN を指定します。この値は大文字と小文字を区別し、小文字で指定する必要があります (例: uuid:e8f85dfd-ff...)。
pDevice	IUPnPDevice**	out	要求されたデバイスを含む IUPnPDevice オブジェクトへの参照を受け取ります。指定したデバイスが見つからない場合は NULL を受け取ります。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合は S_FALSE を返します。

解説(Remarks)

このメソッドは、指定された UDN に一致するデバイスが見つかり次第、制御を返します。デバイスが見つからない場合、制御が返るまでに少なくとも 9 秒、場合によってはそれ以上かかります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUPnPDeviceFinder "{ADDA3D55-6F72-4319-BFF9-18600A539B10}"
#usecom global IUPnPDeviceFinder IID_IUPnPDeviceFinder "{E2085F28-FEB7-404A-B8E7-E659BDEAAA02}"
#comfunc global IUPnPDeviceFinder_FindByType       7 wstr,int,sptr
#comfunc global IUPnPDeviceFinder_CreateAsyncFind  8 wstr,int,sptr,var
#comfunc global IUPnPDeviceFinder_StartAsyncFind   9 int
#comfunc global IUPnPDeviceFinder_CancelAsyncFind  10 int
#comfunc global IUPnPDeviceFinder_FindByUDN        11 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IUPnPDeviceFinder "{ADDA3D55-6F72-4319-BFF9-18600A539B10}"
#usecom global IUPnPDeviceFinder IID_IUPnPDeviceFinder "{E2085F28-FEB7-404A-B8E7-E659BDEAAA02}"
#comfunc global IUPnPDeviceFinder_FindByType       7 wstr,int,sptr
#comfunc global IUPnPDeviceFinder_CreateAsyncFind  8 wstr,int,sptr,sptr
#comfunc global IUPnPDeviceFinder_StartAsyncFind   9 int
#comfunc global IUPnPDeviceFinder_CancelAsyncFind  10 int
#comfunc global IUPnPDeviceFinder_FindByUDN        11 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。