ホーム › Devices.Sensors › ISensorCollection

ISensorCollection

COM

📘 Microsoft Learn (日本語) · English

IID23571e11-e545-4dd8-a337-b89bf44b10df継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

コンピューターに接続されているすべてのセンサーなど、センサーのコレクションを表します。

メソッド 6

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

vtbl 3 HRESULT GetAt(DWORD ulIndex, ISensor** ppSensor)

コレクション内の指定したインデックスにあるセンサーを取得します。

ulIndex	DWORD	in	取得するセンサーのインデックスを格納した ULONG。
ppSensor	ISensor**	out	指定したセンサーへのポインターを受け取る ISensor ポインターのアドレス。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	ppSensor に NULL が渡されました。

vtbl 4 HRESULT GetCount(DWORD* pCount)

コレクション内のセンサーの数を取得します。

pCount

DWORD*

out

数を受け取る ULONG のアドレス。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	pCount に NULL が渡されました。

vtbl 5 HRESULT Add(ISensor* pSensor)

コレクションにセンサーを追加します。

pSensor

ISensor*

inoptional

コレクションに追加するセンサーの ISensor インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード	説明
S_OK	メソッドは成功しました。
HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS)	センサーコレクションには、指定した ID を持つセンサーが既に含まれています。

vtbl 6 HRESULT Remove(ISensor* pSensor)

コレクションからセンサーを削除します。削除するセンサーは、ISensor インターフェイスへのポインターで指定します。

pSensor

ISensor*

inoptional

コレクションから削除する ISensor インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	指定したセンサーはコレクションに含まれていません。

vtbl 7 HRESULT RemoveByID(GUID* sensorID)

コレクションからセンサーを削除します。削除するセンサーは、その ID で指定します。

sensorID

GUID*

コレクションから削除するセンサーの GUID。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	指定したセンサーはコレクションに含まれていません。

vtbl 8 HRESULT Clear()

センサーコレクションを空にします。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード	説明
S_OK	メソッドは成功しました。

解説(Remarks)

このメソッドは、コレクション内のすべてのセンサーインターフェイスポインターに対して Release を呼び出し、コレクションが使用しているメモリを解放します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISensorCollection "{23571E11-E545-4DD8-A337-B89BF44B10DF}"
#usecom global ISensorCollection IID_ISensorCollection "{79C43ADB-A429-469F-AA39-2F2B74B75937}"
#comfunc global ISensorCollection_GetAt       3 int,sptr
#comfunc global ISensorCollection_GetCount    4 var
#comfunc global ISensorCollection_Add         5 sptr
#comfunc global ISensorCollection_Remove      6 sptr
#comfunc global ISensorCollection_RemoveByID  7 var
#comfunc global ISensorCollection_Clear       8
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ISensorCollection "{23571E11-E545-4DD8-A337-B89BF44B10DF}"
#usecom global ISensorCollection IID_ISensorCollection "{79C43ADB-A429-469F-AA39-2F2B74B75937}"
#comfunc global ISensorCollection_GetAt       3 int,sptr
#comfunc global ISensorCollection_GetCount    4 sptr
#comfunc global ISensorCollection_Add         5 sptr
#comfunc global ISensorCollection_Remove      6 sptr
#comfunc global ISensorCollection_RemoveByID  7 sptr
#comfunc global ISensorCollection_Clear       8
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。