ホーム › Devices.Enumeration.Pnp › IUPnPDevice

IUPnPDevice

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID3d44d0d1-98c9-4889-acd1-f9d674bf2221継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IUPnPDevice インターフェイスを使用すると、アプリケーションは特定のデバイスに関する情報を取得できます。

メソッド 19

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

vtbl 7 HRESULT get_IsRootDevice(VARIANT_BOOL* pvarb)

IsRootDevice プロパティは、そのデバイスがデバイスツリーの最上位デバイスであるかどうかを示します。

pvarb

VARIANT_BOOL*

out

デバイスがデバイスツリーの最上位デバイスである場合は VARIANT_TRUE、それ以外の場合は VARIANT_FALSE の値を格納する VARIANT_BOOL への参照を受け取ります。

戻り値

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

vtbl 8 HRESULT get_RootDevice(IUPnPDevice** ppudRootDevice)

RootDevice プロパティは、デバイスツリーの最上位デバイスを示します。ルートデバイスは物理的なオブジェクトを表します。

ppudRootDevice

IUPnPDevice**

out

ルートデバイスを記述する IUPnPDevice オブジェクトへの参照を受け取ります。この参照は不要になった時点で解放する必要があります。

戻り値

vtbl 9 HRESULT get_ParentDevice(IUPnPDevice** ppudDeviceParent)

ParentDevice プロパティは、デバイスの親を示します。

ppudDeviceParent

IUPnPDevice**

out

親デバイスを記述する IUPnPDevice オブジェクトへの参照を受け取ります。この参照は不要になった時点で解放する必要があります。デバイスに親がない場合、そのデバイスは最上位デバイスであり、このパラメーターは NULL を受け取ります。

戻り値

C++ の場合: このプロパティの "get" メソッドが成功した場合、戻り値は S_OK です。デバイスが最上位デバイスである場合、戻り値は S_FALSE です。それ以外の場合、メソッドは WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

デバイスに親がないかどうかを判断するには、IUPnPDevice::IsRootDevice を使用します。

vtbl 10 HRESULT get_HasChildren(VARIANT_BOOL* pvarb)

HasChildren プロパティは、デバイスが子デバイスを持つかどうかを示します。

pvarb

VARIANT_BOOL*

out

デバイスが 1 つ以上の子デバイスを持つ場合は VARIANT_TRUE、それ以外の場合は VARIANT_FALSE の値を格納する VARIANT_BOOL への参照を受け取ります。

戻り値

解説(Remarks)

アプリケーションが IUPnPDevice::Children プロパティにアクセスすべきかどうかを判断するには、このプロパティを使用します。

vtbl 11 HRESULT get_Children(IUPnPDevices** ppudChildren)

Children プロパティは、デバイスのすべての子デバイスを示します。デバイスは IUPnPDevices コレクションに格納されます。

ppudChildren

IUPnPDevices**

out

デバイスの子デバイスを列挙する IUPnPDevices コレクションへの参照を受け取ります。この参照は不要になった時点で解放する必要があります。

デバイスが子デバイスを持たない場合、コレクションオブジェクトの長さは 0 になります。

戻り値

解説(Remarks)

デバイスが子を持つかどうか (実際の子の数ではなく) を判断するには、IUPnPDevice::HasChildren を使用します。

vtbl 12 HRESULT get_UniqueDeviceName(LPWSTR* pbstr)

UniqueDeviceName プロパティは、デバイスの一意のデバイス名 (UDN) を示します。UDN は一意であり、2 つのデバイスが同じ UDN を持つことはありません。

pbstr

LPWSTR*

out

デバイスの UDN を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。

戻り値

vtbl 13 HRESULT get_FriendlyName(LPWSTR* pbstr)

FriendlyName プロパティは、デバイスの表示名を示します。

pbstr

LPWSTR*

out

デバイスの表示名を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。

戻り値

解説(Remarks)

複数のデバイスが同じ表示名を持つ可能性があります。2 つのデバイスオブジェクトが同一のデバイスを記述しているかどうかを判断するには、一意のデバイス名を使用します。詳細については、 UniqueDeviceName を参照してください。

vtbl 14 HRESULT get_Type(LPWSTR* pbstr)

Type メソッドは、デバイスのデバイスタイプの Uniform Resource Identifier (URI) を示します。

pbstr

LPWSTR*

out

デバイスタイプの URI を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。

戻り値

vtbl 15 HRESULT get_PresentationURL(LPWSTR* pbstr)

PresentationURL プロパティは、デバイスを制御する Web ページのプレゼンテーション URL を示します。

pbstr

LPWSTR*

out

Web ページのプレゼンテーション URL を格納する文字列への参照を受け取ります。この URL は絶対 URL です。この文字列は不要になった時点で SysFreeString で解放してください。デバイスがプレゼンテーション URL を指定していない場合、このパラメーターは空の文字列を受け取ります。

戻り値

C++ の場合: このプロパティの "get" メソッドが成功した場合、戻り値は S_OK です。デバイスがプレゼンテーション URL を指定していない場合、戻り値は S_FALSE です。それ以外の場合、メソッドは WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

注意このプロパティは空であってはならず、有効な URL を格納している必要があります。

vtbl 16 HRESULT get_ManufacturerName(LPWSTR* pbstr)

ManufacturerName プロパティは、デバイスの製造元名を人間が読み取れる形式で示します。

pbstr

LPWSTR*

out

製造元名を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。

戻り値

vtbl 17 HRESULT get_ManufacturerURL(LPWSTR* pbstr)

ManufacturerURL プロパティは、製造元の Web サイトの URL を示します。

pbstr

LPWSTR*

out

URL を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。デバイスがこの URL を指定していない場合、このパラメーターには NULL が設定されます。

戻り値

C++ の場合: このプロパティの "get" メソッドが成功した場合、戻り値は S_OK です。デバイスがこの URL を指定していない場合、戻り値は S_FALSE となり、pbstr は NULL になります。それ以外の場合、メソッドは WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

このプロパティは省略可能であり、pbstr は NULL を返すことがあります。

vtbl 18 HRESULT get_ModelName(LPWSTR* pbstr)

ModelName プロパティは、デバイスのモデル名を人間が読み取れる形式で示します。

pbstr

LPWSTR*

out

モデル名を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。

戻り値

vtbl 19 HRESULT get_ModelNumber(LPWSTR* pbstr)

ModelNumber プロパティは、デバイスのモデル番号を人間が読み取れる形式で示します。

pbstr

LPWSTR*

out

モデル番号を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。デバイスがモデル番号を指定していない場合、このパラメーターには NULL が設定されます。

戻り値

C++ の場合: このプロパティの "get" メソッドが成功した場合、戻り値は S_OK です。デバイスがモデル番号を指定していない場合、戻り値は S_FALSE となり、pbstr は NULL になります。それ以外の場合、メソッドは WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

このプロパティは省略可能であり、pbstr は NULL を返すことがあります。

vtbl 20 HRESULT get_Description(LPWSTR* pbstr)

Description プロパティは、デバイスの機能の概要を人間が読み取れる形式で示します。

pbstr

LPWSTR*

out

この種類のデバイスが想定する機能の簡単な説明を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。デバイスが説明を指定していない場合、このパラメーターには NULL が設定されます。

戻り値

解説(Remarks)

このプロパティは省略可能であり、pbstr は NULL を返すことがあります。

vtbl 21 HRESULT get_ModelURL(LPWSTR* pbstr)

ModelURL プロパティは、デバイスのモデル固有の情報を掲載した Web ページの URL を示します。

pbstr

LPWSTR*

out

戻り値

解説(Remarks)

このプロパティは省略可能であり、pbstr は NULL になることがあります。

vtbl 22 HRESULT get_UPC(LPWSTR* pbstr)

UPC プロパティは、製品コードを人間が読み取れる形式で示します。

pbstr

LPWSTR*

out

製品コードを格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。デバイスが製品コードを指定していない場合、このパラメーターは空の文字列を受け取ります。

戻り値

C++ の場合: このプロパティの "get" メソッドが成功した場合、戻り値は S_OK です。デバイスが製品コードを指定していない場合、戻り値は S_FALSE です。それ以外の場合、メソッドは WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

このプロパティは省略可能であり、pbstr は NULL になることがあります。

複数のデバイスが同じ製品コードを持つ可能性があります。2 つのデバイスオブジェクトが同一のデバイスを記述しているかどうかを判断するには、一意のデバイス名を使用します。詳細については、 UniqueDeviceName を参照してください。

vtbl 23 HRESULT get_SerialNumber(LPWSTR* pbstr)

SerialNumber プロパティは、デバイスのシリアル番号を人間が読み取れる形式で示します。

pbstr

LPWSTR*

out

シリアル番号を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。このプロパティは省略可能であり、デバイスがシリアル番号を持たない場合もあります。

戻り値

C++ の場合: このプロパティの "get" メソッドが成功した場合、戻り値は S_OK です。デバイスがシリアル番号を指定していない場合、戻り値は S_FALSE です。それ以外の場合、メソッドは WinError.h で定義されている COM エラーコードのいずれかを返します。

解説(Remarks)

このプロパティは省略可能であり、pbstr は NULL になることがあります。

複数のデバイスが同じシリアル番号を持つ可能性があります。2 つのデバイスオブジェクトが同一のデバイスを記述しているかどうかを判断するには、一意のデバイス名を使用します。詳細については、 UniqueDeviceName を参照してください。

vtbl 24 HRESULT IconURL(LPWSTR bstrEncodingFormat, INT lSizeX, INT lSizeY, INT lBitDepth, LPWSTR* pbstrIconURL)

IconURL メソッドは、指定した形式のアイコンを読み込むための URL を返します。

bstrEncodingFormat	LPWSTR	in	アイコンに要求するエンコード形式の MIME タイプを指定します。
lSizeX	INT	in	アイコンの幅をピクセル単位で指定します。標準的な値は 16、32、48 です。
lSizeY	INT	in	アイコンの高さをピクセル単位で指定します。標準的な値は 16、32、48 ピクセルです。
lBitDepth	INT	in	アイコンのビット深度を指定します。標準的な値は 8、16、24 です。
pbstrIconURL	LPWSTR*	out	アイコンの読み込み元となる URL を格納する文字列への参照を受け取ります。この文字列は不要になった時点で SysFreeString で解放してください。

戻り値

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

解説(Remarks)

アプリケーションは lSizeX、lSizeY、lBitDepth に任意の値を指定できます。ただし、その仕様に一致するアイコンが存在する保証はありません。

一致するアイコンが存在しない場合は、指定されたサイズおよびビット深度に最も近いアイコンの URL が返されます。

vtbl 25 HRESULT get_Services(IUPnPServices** ppusServices)

Services プロパティは、デバイスが提供するサービスの一覧を示します。

ppusServices

IUPnPServices**

out

デバイスが提供するサービスを列挙する IUPnPServices コレクションへの参照を受け取ります。この参照は不要になった時点で解放する必要があります。

戻り値

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUPnPDevice "{3D44D0D1-98C9-4889-ACD1-F9D674BF2221}"
#usecom global IUPnPDevice IID_IUPnPDevice "{}"
#comfunc global IUPnPDevice_get_IsRootDevice      7 var
#comfunc global IUPnPDevice_get_RootDevice        8 sptr
#comfunc global IUPnPDevice_get_ParentDevice      9 sptr
#comfunc global IUPnPDevice_get_HasChildren       10 var
#comfunc global IUPnPDevice_get_Children          11 sptr
#comfunc global IUPnPDevice_get_UniqueDeviceName  12 var
#comfunc global IUPnPDevice_get_FriendlyName      13 var
#comfunc global IUPnPDevice_get_Type              14 var
#comfunc global IUPnPDevice_get_PresentationURL   15 var
#comfunc global IUPnPDevice_get_ManufacturerName  16 var
#comfunc global IUPnPDevice_get_ManufacturerURL   17 var
#comfunc global IUPnPDevice_get_ModelName         18 var
#comfunc global IUPnPDevice_get_ModelNumber       19 var
#comfunc global IUPnPDevice_get_Description       20 var
#comfunc global IUPnPDevice_get_ModelURL          21 var
#comfunc global IUPnPDevice_get_UPC               22 var
#comfunc global IUPnPDevice_get_SerialNumber      23 var
#comfunc global IUPnPDevice_IconURL               24 wstr,int,int,int,var
#comfunc global IUPnPDevice_get_Services          25 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IUPnPDevice "{3D44D0D1-98C9-4889-ACD1-F9D674BF2221}"
#usecom global IUPnPDevice IID_IUPnPDevice "{}"
#comfunc global IUPnPDevice_get_IsRootDevice      7 sptr
#comfunc global IUPnPDevice_get_RootDevice        8 sptr
#comfunc global IUPnPDevice_get_ParentDevice      9 sptr
#comfunc global IUPnPDevice_get_HasChildren       10 sptr
#comfunc global IUPnPDevice_get_Children          11 sptr
#comfunc global IUPnPDevice_get_UniqueDeviceName  12 sptr
#comfunc global IUPnPDevice_get_FriendlyName      13 sptr
#comfunc global IUPnPDevice_get_Type              14 sptr
#comfunc global IUPnPDevice_get_PresentationURL   15 sptr
#comfunc global IUPnPDevice_get_ManufacturerName  16 sptr
#comfunc global IUPnPDevice_get_ManufacturerURL   17 sptr
#comfunc global IUPnPDevice_get_ModelName         18 sptr
#comfunc global IUPnPDevice_get_ModelNumber       19 sptr
#comfunc global IUPnPDevice_get_Description       20 sptr
#comfunc global IUPnPDevice_get_ModelURL          21 sptr
#comfunc global IUPnPDevice_get_UPC               22 sptr
#comfunc global IUPnPDevice_get_SerialNumber      23 sptr
#comfunc global IUPnPDevice_IconURL               24 wstr,int,int,int,sptr
#comfunc global IUPnPDevice_get_Services          25 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。