IConsolePowerSink
COM公式ドキュメント
IConsolePowerSink インターフェイスは、電源管理メッセージを監視して応答します。
解説(Remarks)
電源管理通知を受け取るには、スナップインが AtlAdvise 関数を使用して、 IConsolePower インターフェイスのインスタンスを IConsolePowerSink インターフェイスの実装に関連付ける必要があります。次のコード例は、AtlAdvise 関数の使用方法を示しています。
例
// IConsolePower インターフェイスと IConsolePowerSink インターフェイスを接続します。
// m_ipConsolePower は
// IConsolePower インターフェイスのインスタンスへのポインターです。
// m_ipConsolePowerSink は
// IConsolePowerSink インターフェイスのインスタンスへのポインターです。
// m_dwCookie は DWORD 型です。
hr = AtlAdvise(m_ipConsolePower,
m_ipConsolePowerSink,
IID_IConsolePowerSink,
&m_dwCookie);
スナップインが閉じるとき、または電源管理通知が不要になったときは、AtlUnadvise 関数を呼び出して、 IConsolePower インターフェイスと IConsolePowerSink インターフェイス間の接続を終了します。次のコード例は、AtlUnadvise 関数の使用方法を示しています。
// 前に確立した接続を終了します。
hr = AtlUnadvise(m_ipConsolePower,
IID_IConsolePowerSink,
m_dwCookie);
メソッド 1
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
OnPowerBroadcast メソッドは、コンピューターの電源管理に関連する WM_POWERBROADCAST 通知メッセージを処理します。
| nEvent | DWORD | in | 電源ブロードキャストイベントの識別子。識別子は次のいずれかの値です。 PBT_APMBATTERYLOWバッテリー残量が少なくなっています。 PBT_APMOEMEVENTOEM 定義のイベントが発生しました。 PBT_APMPOWERSTATUSCHANGE電源の状態が変化しました。 PBT_APMQUERYSUSPENDサスペンドの許可を求める要求です。 PBT_APMQUERYSUSPENDFAILEDサスペンド要求が拒否されました。 PBT_APMRESUMEAUTOMATICイベント後に自動的に動作を再開します。 PBT_APMRESUMECRITICAL重大なサスペンドの後に動作を再開します。 PBT_APMRESUMESUSPENDサスペンドの後に動作を再開します。 PBT_APMSUSPENDシステムが動作をサスペンドしています。 |
| lParam | LPARAM | in | 関数固有のデータ。ほとんどのイベントでは、このパラメーターは予約済みで使用されません。ただし、nEvent がいずれかの再開イベント (PBT_APMRESUME*) の場合、lParam パラメーターに PBTF_APMRESUMEFROMFAILURE フラグを指定できます。このフラグは、PBT_APMSUSPEND イベントがブロードキャストされた後にサスペンド操作が失敗したことを示します。 |
| plReturn | LRESULT* | out | 戻り値として、ブロードキャストイベントに対するスナップインの応答を返します。通常は plReturn を TRUE に設定します。例外は nEvent が PBT_APMQUERYSUSPEND の場合です。PBT_APMQUERYSUSPEND イベントに応答してコンピューターのサスペンドを続行させるには、plReturn を TRUE に設定します。コンピューターのサスペンドを拒否するには、*plReturn を BROADCAST_QUERY_DENY に設定します。コンピューターのサスペンドを許可するスナップインは、このメソッドから戻る前に、必要なサスペンドの準備を行う必要があります。 |
戻り値
成功した場合、戻り値は S_OK です。それ以外の戻り値はエラーコードを示します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IConsolePowerSink "{3333759F-FE4F-4975-B143-FEC0A5DD6D65}" #usecom global IConsolePowerSink IID_IConsolePowerSink "{}" #comfunc global IConsolePowerSink_OnPowerBroadcast 3 int,sptr,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IConsolePowerSink "{3333759F-FE4F-4975-B143-FEC0A5DD6D65}" #usecom global IConsolePowerSink IID_IConsolePowerSink "{}" #comfunc global IConsolePowerSink_OnPowerBroadcast 3 int,sptr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。