IWMPSyncDevice3
COM公式ドキュメント
IWMPSyncDevice3 インターフェイスは、プレイリストをデバイスに同期するために必要なサイズを見積もるためのメソッドを提供します。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
estimateSyncSize メソッドは、指定したプレイリストを同期するためにデバイス上で必要となるサイズの見積もりを開始します。
| pNonRulePlaylist | IWMPPlaylist* | in | サイズを見積もる対象のプレイリストを表す IWMPPlaylist インターフェイスへのポインター。このパラメーターには NULL を設定できます。この引数を指定すると、見積もりは pNonRulePlaylist と、存在する場合は現在の同期ルールのサイズを返します。 |
| pRulesPlaylist | IWMPPlaylist* | in | サイズを見積もる対象のプレイリストを表す IWMPPlaylist インターフェイスへのポインター。このパラメーターには NULL を設定できます。この引数を指定すると、現在の同期ルールは見積もりから除外され、見積もりは pNonRulePlaylist と pRulesPlaylist のサイズを返します。 |
戻り値
このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。
| 戻りコード | 説明 |
|---|---|
| メソッドは成功しました。 | |
| Windows Media Player がシャットダウン中であるか、pNonRulePlaylist と pRulesPlaylist の両方が NULL です。 | |
| デバイスの同期セッションが既に進行中です。 |
解説(Remarks)
必要なサイズの見積もりは非同期に行われます。つまり、このメソッドは見積もりを開始した後、すぐに制御を返します。見積もりが完了すると、Windows Media Player は IWMPEvents4::SyncEstimationComplete イベントを発生させます。
デバイスの同期セッションが現在進行中の場合、見積もりを実行することはできません。
このメソッドを呼び出した後、最初の見積もりが完了する前に再度呼び出すと、最初の見積もりはキャンセルされ、新しい見積もりが開始されます。
cancelEstimation メソッドは、estimateSyncSize によって以前に開始された見積もりをキャンセルします。
戻り値
このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。
| 戻りコード | 説明 |
|---|---|
| メソッドは成功しました。 |
解説(Remarks)
このメソッドを呼び出すと、Windows Media Player は HRESULT が E_ABORT の IWMPEvents4::SyncEstimationComplete イベントを発生させます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IWMPSyncDevice3 "{B22C85F9-263C-4372-A0DA-B518DB9B4098}"
#usecom global IWMPSyncDevice3 IID_IWMPSyncDevice3 "{}"
#comfunc global IWMPSyncDevice3_estimateSyncSize 20 sptr,sptr
#comfunc global IWMPSyncDevice3_cancelEstimation 21
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。