Win32 API 日本語リファレンス
ホームDevices.Sensors › ISensorEvents

ISensorEvents

COM
IID5d8dcc91-4641-47e7-b7c3-b74f48a6c391継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

センサーのイベントを受け取りたい場合に実装する必要があるコールバックインターフェースです。

メソッド 4

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

vtbl 3 HRESULT OnStateChanged(ISensor* pSensor, SensorState state)

センサーの状態が変化したことを通知します。

pSensorISensor*inoptionalイベントを発生させたセンサーの ISensor インターフェースへのポインター。
stateSensorStatein新しい状態を格納した SensorState

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
vtbl 4 HRESULT OnDataUpdated(ISensor* pSensor, ISensorDataReport* pNewData)

センサーのイベントデータを提供します。

pSensorISensor*inoptionalイベントを発生させたセンサーの ISensor インターフェースへのポインター。
pNewDataISensorDataReport*inoptionalイベントデータを格納した ISensorDataReport インターフェースへのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
vtbl 5 HRESULT OnEvent(ISensor* pSensor, GUID* eventID, IPortableDeviceValues* pEventData)

カスタムイベントの通知を提供します。

pSensorISensor*inoptionalイベントを発生させたセンサーを表す ISensor インターフェースへのポインター。
eventIDGUID*inイベントを識別する REFGUID
pEventDataIPortableDeviceValues*inoptionalイベントデータを格納した IPortableDeviceValues インターフェースへのポインター。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このコールバックメソッドはカスタムイベントの通知を受け取ります。カスタムイベントはセンサープロバイダーによって定義されます。プラットフォームで定義されるイベントIDは Sensors.h で定義されています。

センサーから新しいデータを受け取るには、OnDataUpdated メソッドを使用してください。

センサーのイベントを受け取る方法の例については、Using Sensor API Events を参照してください。

vtbl 6 HRESULT OnLeave(GUID* ID)

センサーデバイスが接続されなくなったことを通知します。

IDGUID*inセンサーのID。

戻り値

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

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

解説(Remarks)

センサーが接続されたタイミングを知るには、ISensorManagerEvents::OnSensorEnter イベントをサブスクライブしてください。

センサーのイベントを受け取る方法の例については、Using Sensor API Events を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ISensorEvents "{5D8DCC91-4641-47E7-B7C3-B74F48A6C391}"
#usecom global ISensorEvents IID_ISensorEvents "{}"
#comfunc global ISensorEvents_OnStateChanged  3 sptr,int
#comfunc global ISensorEvents_OnDataUpdated   4 sptr,sptr
#comfunc global ISensorEvents_OnEvent         5 sptr,var,sptr
#comfunc global ISensorEvents_OnLeave         6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。